WebhooksOrdersETA & Delays
Order ETA Change
Webhook payload sent when the ETA for an order changes.
Order ETA Change Webhook Payload
[
{
"created_at":"2021-01-01T14:01:00.000000Z",
"recorded_at":"2021-01-01T14:00:00.000000Z",
"device_id":"00112233-4455-6677-8899-AABBCCDDEEFF",
"worker_handle": "Worker-1",
"account_id":"6784e919-7168-4f61-b686-2020f547637f",
"type":"order",
"data":{
"value":"eta_change",
"order_handle":"DGC127092",
"route_handle":"4359cc65-90dd-4b2b-875b-26e6d2eba11d",
"remaining_distance": 2382,
"remaining_duration": 359,
"status":"ongoing",
"share_url":"https://trck.at/vr1RNLq",
"change_reason": "position_update",
"metadata":{
"storeId":"123490809808",
"customerName":"Andrew"
}
},
"version":"3.0.0"
}
]| Name | Type | Mandatory | Description |
|---|---|---|---|
| data.value | string | Yes | eta_change |
| data.order_handle | string | Yes | Unique handle for the Order |
| data.route_handle | string | Yes | Unique identifier of the route containing the order |
| data.status | string | Yes | Status of the order - ongoing |
| data.share_url | string | Yes | Contains tracking url of the order to provide real time visibility of worker on route of this order |
| data.change_reason | string | Yes | contains the reason of why eta changed, enumerated as one of: position_update (ETA recalculated from worker's new position), route_change (Route to destination was recalculated), or traffic_update (Real-time traffic conditions changed). Note: traffic_update can also lead to a route recalculation |
| data.metadata | object | No | Metadata that you have assigned to this order |
| data.remaining_distance | int | Yes | Distance remaining in meters |
| data.remaining_duration | int | Yes | Time remaining to reach destination as per current location in seconds |
| data.earliest_possible_arrival_time | string | No | Earliest arrival time assuming free-flowing traffic from the current known location of the worker |