Authentication
Vehicles
Drivers
Devices
Groups
Data Management
Providers
Webhook Events
- Event Types
- connection.created
- connection.disconnected
- connection.reconnected
- connection.completed
- connection.updated
- sync.requested
- sync.started
- sync.completed
- sync.failed
- connection.first_sync_completed
- issue.reported
- issue.resolved
- unsupported_provider.requested
- vehicle.added
- vehicle.modified
- vehicle.removed
- driver.added
- driver.modified
- driver.removed
- safety_event.added
- safety_event.modified
driver.added
"evt_01GV12VR4DJP70GD1ZBK0SDWFH"
driver.added Basic connection details to be able to reference connections from webhook events
"conn_01GV12VR4DJP70GD1ZBK0SDWFH"
Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.
"geotab"
"Geotab"
"123456789"
Unique identifier for the driver in Terminal.
"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
The ID used to represent the entity in the source system.
"123456789"
Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.
"geotab"
The status in the providers system
active, inactive Internal metadata about the record.
The date and time the record was ingested into Terminal. Note: this is not the date and time the record was created in the provider's system.
The date and time the record was last updated in Terminal. Note: this is not the date and time the record was updated in the provider's system.
The date and time the record was deleted from Terminal. Note: this is not the date and time the record was deleted in the provider's system.
"Mike"
"Bryan"
"Miller"
"driver@example.com"
US State or Canadian Province
AL, AK, AS, AZ, AR, CA, CO, CT, DE, FL, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MP, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, VI, AB, BC, MB, NB, NL, NS, ON, PE, QC, SK, NT, NU, UM, YT, DC "TN"
"123-456-789-0"
Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.
The date and time the record was created in the provider's system. This timestamp comes directly from the source system and represents when the data was originally created there. Note: not all providers expose this.
The date and time the record was updated in the provider's system. This timestamp comes directly from the source system and represents when the data was last updated there. Note: not all providers expose this.
Raw data fetched from the source provider. Most of our endpoints support a raw query parameter that will append a list of the raw requests used to form our common model. This can be helpful for leveraging unique fields that are not part of our unified model.
[]
{
"id": "evt_01GV12VR4DJP70GD1ZBK0SDWFH",
"type": "driver.added",
"timestamp": "2021-01-06T03:24:53.000Z",
"detail": {
"connection": {
"id": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
"provider": {
"code": "geotab",
"name": "Geotab"
},
"externalId": "123456789",
"tags": [
"<string>"
]
},
"driver": {
"id": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
"sourceId": "123456789",
"provider": "geotab",
"status": "active",
"firstName": "Mike",
"middleName": "Bryan",
"lastName": "Miller",
"email": "driver@example.com",
"phone": "+19058084567",
"license": {
"state": "TN",
"number": "123-456-789-0"
},
"groups": [
"group_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"metadata": {
"addedAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"visibility": "visible"
},
"raw": []
}
}
}