WebhooksDeprecated
Device Status
Deprecated webhook payload sent when the status of a device changes.
{
"device_id":"AAAAAAAA-7101-48A9-86C4-B762993ACC5A",
"driver_handle": "ram@124",
"recorded_at":"2021-10-27T00:40:53.811Z",
"metadata":{
"invite_id":"https://hypertrack-logistics.app.link/xxxx",
"email":"alex+test123@hypertrack.com"
},
"version":"2.0.0",
"location":{
"type":"Point",
"coordinates":[
-122.503655,
37.76097,
24.98
]
},
"created_at":"2021-10-27T00:42:01.166509Z",
"name":"Alex",
"data":{
"value": "inactive",
"outage_category": "behavioural",
"outage_code": "location_permissions_denied",
"outage_label": "Location permissions denied",
"outage_description": "The worker explicitly denied permissions in response to system prompt or in Settings > App Name > Location on iOS. On Android, the worker should change location permission to 'Allow' in App Info > Permissions > Location.",
"location_start": {
"type": "Point",
"coordinates":[
-122.503655,
37.76097,
24.98
]
},
"recorded_at_start": "2021-10-27T00:40:53.811Z"
},
"type":"device_status"
}| Name | Type | Description |
|---|---|---|
| data.value | string | Device status: active, inactive or disconnected. See Device Status. |
| data.activity | string | For active devices only: walk, drive, or stop. |
| data.outage_category | enum | Outage category: adversarial, behavioural, sporadic, os, or reachability. |
| data.outage_label | string | Short human-readable label for the outage reason. |
| data.outage_code | string | Machine-readable identifier of the outage reason. See Outage code values. |
| data.outage_description | string | Human-readable description of the outage and remediation guidance. |
| data.start | object | When data.value is active and an activity has completed, indicates when and where the activity started. |
| data.end | object | When data.value is active and an activity has completed, indicates when and where the activity ended. |
| data.distance | int | Available when data.value is active and an activity has completed. |
| data.duration | int | Available when data.value is active and an activity has completed. |
| location | object | Location in GeoJSON format. |
| location.type | string | Only Point is supported. |
| location.coordinates | array | Array of longitude, latitude, and optional altitude (in meters). |