Whenever a webhook is triggered, the current state of the order will be included in the payload along with the event name. The schema of the payload remains consistent across all events.
{
"event": <string>,
"payload": {
"orderId": <string>,
"externalId": <string>,
"order": {
"total": <number>,
"itemCount": <number>,
"description": <string>,
"tip": <number>,
"serviceTime": <number>
},
"pickupDetails": {
"name": <string>,
"businessName": <string>,
"address": <string>,
"instructions": <string>,
"phone": <string>,
"location": {
"latitude": <float>,
"longitude": <float>
},
"scheduledPickupAt": <datetime-string>,
"schedulePickupBeforeAt": <datetime-string>
},
"dropoffDetails": {
"name": <string>,
"businessName": <string>,
"address": <string>,
"instructions": <string>,
"phone": <string>,
"location": {
"latitude": <float>,
"longitude": <float>
},
"scheduledDropoffAt": <datetime-string>,
"scheduleDropoffAfterAt": <datetime-string>
},
"deliveryRequirements": {
"signature": <boolean>,
"photo": <boolean>,
"notes": <boolean>
},
"internalId": <string>,
"assigneeId": <string>,
"status": <string>,
"statusDetails": {
"pickupInTransit": <datetime-string>,
"pickupArrived": <datetime-string>,
"pickupCompleted": <datetime-string>,
"dropoffIntransit": <datetime-string>,
"dropoffArrived": <datetime-string>,
"dropoffCompleted": <datetime-string>
},
"eta": <datetime-string>,
"attachments": [
{
"url": <string>,
"type": <string>
}
]
}
}
{
"event": "ORDER_IN_TRANSIT_TO_PICKUP",
"payload": {
"orderId": "8b9f138e-4600-43cd-8659-f823799b1983",
"externalId": "SWT-1001",
"order": {
"total": 100,
"itemCount": 2,
"description": "Order description",
"tip": 10,
"serviceTime": 9
},
"pickupDetails": {
"name": "Shohidul Bari",
"businessName": "Fulflld Ltd.",
"address": "501 Stanyan St, San Francisco, CA 94117",
"instructions": "Call me!",
"phone": "+14155552671",
"location": {
"latitude": 37.7763,
"longitude": -122.4327
},
"scheduledPickupAt": "2024-12-01T15:15:22Z",
"schedulePickupBeforeAt": "2024-12-01T15:15:22Z"
},
"dropoffDetails": {
"name": "Sumaiya Akter",
"businessName": "United medical ltd.",
"address": "710 Steiner St, San Francisco, CA 94117",
"instructions": "Call me!",
"phone": "+14155552671",
"location": {
"latitude": 37.7763,
"longitude": -122.4327
},
"scheduledDropoffAt": "2024-12-01T15:15:22Z",
"scheduleDropoffAfterAt": "2024-12-01T15:15:22Z"
},
"deliveryRequirements": {
"signature": true,
"photo": true,
"notes": true
},
"internalId": "string",
"assigneeId": "string",
"status": "string",
"statusDetails": {
"pickupInTransit": "2024-12-10T21:08:17.541Z",
"pickupArrived": "2024-12-10T21:08:17.541Z",
"pickupCompleted": "2024-12-10T21:08:17.541Z",
"dropoffIntransit": "2024-12-10T21:08:17.541Z",
"dropoffArrived": "2024-12-10T21:08:17.541Z",
"dropoffCompleted": "2024-12-10T21:08:17.541Z"
},
"eta": "2024-12-10T21:08:17.541Z",
"attachments": [
{
"url": "string",
"type": "string"
}
]
}
}