Webhook Events
issue.reported
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
Webhook Events
issue.reported
Emitted when an issue with a connection has been reported.
Example:
"evt_01GV12VR4DJP70GD1ZBK0SDWFH"
Available options:
issue.reported Basic connection details to be able to reference connections from webhook events
Example:
"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.
Example:
"geotab"
Example:
"Geotab"
Example:
"123456789"
Example:
"isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"
Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.
Example:
"conn_01GV12VR4DJP70GD1ZBK0SDWFH"
Available options:
ongoing, resolved Available options:
missing_permissions, exceeded_retention_window, invalid_source_id, unknown_device_type, missing_safety_configuration, inaccessible_data Example:
"Failed to ingest HOS Logs, missing permissions to access Duty Status Logs"
{
"id": "evt_01GV12VR4DJP70GD1ZBK0SDWFH",
"type": "issue.reported",
"timestamp": "2021-01-06T03:24:53.000Z",
"detail": {
"connection": {
"id": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
"provider": {
"code": "geotab",
"name": "Geotab"
},
"externalId": "123456789",
"tags": [
"<string>"
]
},
"issue": {
"id": "isu_01D8ZQFGHVJ858NBF2Q7DV9MNC",
"connection": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
"status": "ongoing",
"error": {
"code": "missing_permissions",
"message": "Failed to ingest HOS Logs, missing permissions to access Duty Status Logs"
},
"firstReportedAt": "2021-01-06T03:24:53.000Z",
"lastReportedAt": "2021-01-06T03:24:53.000Z"
}
}
}