Alerts are driving events captured by Driver•i® device. The application generates real-time Alerts to ensure visibility of the driving behavior and incidents that need quick action. This helps monitor performance, and proactively address any incidents caused and prevent them from happening in the future.
The alert webhook pushes the latest data when an Alert is generated and updated data for the following events:
Changes to Alert Status
- When the Alert status is changed from the previous status
- When the Alert is rejected by the user
- When the Alert is converted to a DriverStar. The newly created DriverStar will be posted and the old Alert will be replaced with updated data.
Changes to Video Status
- When a new video is available (full or trimmed)
- When the video gets annotated
- When the video is deleted on the device
Updates to Driver Assignment
- When the driver data changes during a driver assignment update.
- When the alert assigned to a driver previously was changed during the driver assignment update. In this case, the alert webhook pushes the details with new driver data as an alert update and replaces the old alert with updated data.
The following table describes the parameters for the Alert event:
|
Parameter |
Description |
|||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
duration |
The duration of the alert. |
|||||||||||||||||||||||||||||||||
|
gpsData |
Indicates the GPS coordinates:
|
|||||||||||||||||||||||||||||||||
|
tenantName |
The unique name of the Fleet. |
|||||||||||||||||||||||||||||||||
|
driver |
Information about the driver. Includes the following:
|
|||||||||||||||||||||||||||||||||
|
details |
Alert information. Includes the following:
|
|||||||||||||||||||||||||||||||||
|
videos |
Video information. Includes the following:
|
|||||||||||||||||||||||||||||||||
|
id |
Unique Alert identifier |
|||||||||||||||||||||||||||||||||
|
timestamp |
Time when the alert was generated. |
|||||||||||||||||||||||||||||||||
|
updatedOn |
Time when the Alert was updated (This is a new parameter. It is supported from January 2021. |
|||||||||||||||||||||||||||||||||
|
status |
Status of the Alert. Possible values are:
(This is a new parameter supported for changes to any of the Alert properties. It is supported from January 2021). |
|||||||||||||||||||||||||||||||||
|
vehicle |
Vehicle information. Includes the following:
|
|||||||||||||||||||||||||||||||||
|
webhookType |
The event corresponding to the webhook, in this case “alert”. |
|||||||||||||||||||||||||||||||||
|
camera |
Camera information. Includes the following: id: Unique camera identifier. |
This is the Webhook sample payload to share the Alert event detected.
{
"gpsData": [{
"latitude": 38.258686,
"timestamp": 1608503046840,
"longitude": -85.72605
},
{
"latitude": 38.258686,
"timestamp": 1608503046840,
"longitude": -85.72605
}
],
"videos": [{
"id": 13107312725,
"position": 1,
"status": 1,
"timestamp": 1608502989597
},
{
"id": 13107312726,
"position": 2,
"status": 1,
"timestamp": 1608502989597
},
{
"id": 13107312727,
"position": 3,
"status": 1,
"timestamp": 1608502989597
},
{
"id": 13107312728,
"position": 4,
"status": 1,
"timestamp": 1608502989597
},
{
"id": 13107312729,
"position": 5,
"status": 1,
"timestamp": 1608502989597
},
{
"id": 13107312730,
"position": 6,
"status": 1,
"timestamp": 1608502989597
},
{
"id": 13107312731,
"position": 7,
"status": 1,
"timestamp": 1608502989597
},
{
"id": 13107312724,
"position": 0,
"status": 2,
"timestamp": 1608502989597
}
],
"updatedOn": 1608503341540,
"vehicle": {
"vehicleNumber": "xxxxxx",
"vin": " xxxxxx"
},
"webhookType": "alert",
"duration": 1,
"tenantName": "xxxxxx",
"driver": {
"firstName": "xxxxxx",
"lastName": "xxxxxx",
"driverId": "xxxxxx"
},
"details": {
"severity": 2,
"confidence": null,
"cause": 2,
"typeId": 4,
"typeDescription": "HIGH-G",
"alertVideoStatus": 2,
"severityDescription": "WARN",
"category": 1,
"subTypeDescription": "Moderate Impact",
"categoryDescription": "Regular Alert"
},
"id": 43,
"camera": {
"id": "1630019XXXX"
},
"timestamp": 1608503046840,
"status": "CONFIRMED"
}