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
vehicle.added
"evt_01GV12VR4DJP70GD1ZBK0SDWFH"
vehicle.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 vehicle in Terminal.
"vcl_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 "1HGCM82633A004352"
"Big Red"
"Peterbilt"
"Model 579"
2016
Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.
Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.
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"
"ABC-1234"
gasoline, diesel, propane, electric, hybrid_gasoline, hybrid_diesel Fuel efficiency measurement in liters per 100 km.
27.4
Maximum amount of fuel vehicle can hold in liters.
95.33
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": "vehicle.added",
"timestamp": "2021-01-06T03:24:53.000Z",
"detail": {
"connection": {
"id": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
"provider": {
"code": "geotab",
"name": "Geotab"
},
"externalId": "123456789",
"tags": [
"<string>"
]
},
"vehicle": {
"id": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
"sourceId": "123456789",
"provider": "geotab",
"status": "active",
"vin": "1HGCM82633A004352",
"name": "Big Red",
"make": "Peterbilt",
"model": "Model 579",
"year": 2016,
"groups": [
"group_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"devices": [
"dvc_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"licensePlate": {
"state": "TN",
"number": "ABC-1234"
},
"fuelType": "gasoline",
"fuelEfficiency": 27.4,
"fuelTankCapacity": 95.33,
"raw": []
}
}
}