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
sync.started
Emitted when a connection sync has started running.
"evt_01GV12VR4DJP70GD1ZBK0SDWFH"
sync.started 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"
An object containing the state of a sync job. This can be polled after connection linking to know when data is available for ingestion.
"sync_01GV12VR4DJP70GD1ZBK0SDWFH"
The status of the sync
requested, in_progress, completed, failed "completed"
If the sync failed, this will contain the reason
"Reason for failure if sync status is 'failed'"
Issues are problems encountered with a connection that did not result in a failed sync but may require manual intervention. You can see the issues for a given sync by providing issues to the expand parameter.
Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.
The earliest records to sync for those based on time (ex: historical locations and stats)
"2021-01-06T03:24:53.000Z"
1
{
"id": "evt_01GV12VR4DJP70GD1ZBK0SDWFH",
"type": "sync.started",
"timestamp": "2021-01-06T03:24:53.000Z",
"detail": {
"connection": {
"id": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
"provider": {
"code": "geotab",
"name": "Geotab"
},
"externalId": "123456789",
"tags": [
"<string>"
]
},
"sync": {
"id": "sync_01GV12VR4DJP70GD1ZBK0SDWFH",
"status": "completed",
"failureReason": "Reason for failure if sync status is 'failed'",
"issues": [
"isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"startFrom": "2021-01-06T03:24:53.000Z",
"requestedAt": "2021-01-06T03:24:53.000Z",
"completedAt": "2021-01-06T03:24:53.000Z",
"attempts": 1
}
}
}