Create an Event

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Purpose: Use this endpoint if you want to create either a driver's ON_DUTY or an OFF_DUTY event.

📘

NOTE

This event will return the response as error for the following scenarios.

  • If the earlier event and the current event are same. For example, if you've already created and OFF_DUTY event and are trying to create another OFF_DUTY event for the same driver.
  • If the earlier event was actually a driving event.
  • For the OFF_DUTY events to be captured, it is required for the drivers to log in to the Motive Driver's app. The first time log in when the app is installed on the device, will suffice.
{
  "driver_id":14124,
  "time":"2024-03-31T00:09:00",
  "type":"on_duty",
  "city":"New York",
  "state":"NY",
  "notes":"External System"
}
{
  "driver_id":14124,
  "time":"2024-03-31T00:09:00",
  "type":"off_duty",
  "city":"New York",
  "state":"NY",
  "notes":"External System"
}

Response Parameters

id

  • Type: Integer
  • Description: The unique identifier of the event.

time

  • Type: String (DateTime)
  • Description: The timestamp when the event occurred.

type

  • Type: String
  • Description: The type of event (e.g., on_duty).

city

  • Type: String
  • Description: The city where the event took place (if available).

state

  • Type: String
  • Description: The state where the event took place (if available).

notes

  • Type: String
  • Description: Any additional notes associated with the event.

location

  • Type: String
  • Description: The specific location of the event.

origin

  • Type: String
  • Description: The source of the event (e.g., api).

created_at

  • Type: String (DateTime)
  • Description: The timestamp when the event was created.

updated_at

  • Type: String (DateTime)
  • Description: The timestamp when the event was last updated.

driver

  • Type: Object
  • Description: Contains details about the driver associated with the event.

id

  • Type: Integer
  • Description: The unique identifier of the driver.

first_name

  • Type: String
  • Description: The first name of the driver.

last_name

  • Type: String
  • Description: The last name of the driver.

username

  • Type: String
  • Description: The username of the driver.

email

  • Type: String
  • Description: The email address of the driver.

driver_company_id

  • Type: Integer
  • Description: The company ID associated with the driver or the user. (if applicable).

status

  • Type: String
  • Description: The current status of the user (e.g., active).

role

  • Type: String
  • Description: The role of the user (e.g., driver).

Body Params
int32

Specify the ID of the driver for whom you are creating this event.

date

Specify the time when the event was created.

string

Specify the type of event. Allowed values are:

  • on_duty
  • off_duty

string

Specify any notes for this event.

string

Specify the CITY where the event occurred.

string

Specify the state where the event occurred.

string

Specify the location where the event occured.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/xml