Docs βΊ Webhooks
Event catalog
Every event, with Nash and Onfleet equivalents.
Subscribe to exact names, to delivery.*-style wildcards, or to * for everything. GET /v1/webhooks/events returns this list live.
Delivery events
| Event | Nash equivalent | Onfleet equivalent | Fires when |
|---|---|---|---|
delivery.created | created | taskCreated | The order is created. |
delivery.scheduled | scheduled | β | Created with a pickup window more than an hour out. |
delivery.not_assigned_driver | not_assigned_driver | β | No driver could be assigned yet. |
delivery.assigned_driver | assigned_driver | taskAssigned | A driver accepts or is assigned. |
delivery.unassigned_driver | β | taskUnassigned | The driver is removed. |
delivery.started | started | taskStarted | The driver starts the job. |
delivery.pickup_enroute | pickup_enroute | β | Heading to the pickup. |
delivery.pickup_arrived | pickup_arrived | taskArrival | Arrived at the pickup. |
delivery.pickup_complete | pickup_complete | taskCompleted (pickup) | Order collected. |
delivery.dropoff_enroute | dropoff_enroute | β | Heading to the dropoff. |
delivery.dropoff_arrived | dropoff_arrived | taskArrival | Arrived at the dropoff. |
delivery.dropoff_complete | dropoff_complete | taskCompleted | Delivered. |
delivery.failed | failed | taskFailed | A stop failed; the payload has failureReason. |
delivery.canceled_by_merchant | canceled_by_customer | taskDeleted | Cancelled by you (API or portal). |
delivery.canceled_by_customer | canceled_by_customer | taskDeleted | Cancelled by the end customer. |
delivery.canceled_by_provider | canceled_by_provider | β | Cancelled by Dragonfly. |
delivery.return_in_progress, delivery.return_arrived, delivery.returned | same | β | Returning an undeliverable order to the pickup. |
delivery.expired | expired | β | The window passed without delivery. |
delivery.updated | (task) updated | taskUpdated | Stop or order fields changed. |
delivery.eta, delivery.arrival, delivery.delayed, delivery.predicted_delay | β | taskEta, taskArrival, taskDelayed, predictedTaskDelay | ETA and delay alerts. |
delivery.proof_of_delivery | proof_of_delivery | taskUpdated | A photo, signature or scan was captured. |
delivery.pincode_verification | pincode_verification | β | A PIN was verified. |
delivery.id_verification | β | β | ID/age check result (passed, ageYears, method). |
delivery.barcode_scanned | items_pick_update | taskUpdated | Barcodes were scanned. |
delivery.tracking_viewed | β | taskUpdated | The recipient opened the tracking page. |
Other events
| Event | Fires when |
|---|---|
courier_location.updated | Driver GPS while on your live order (at most every 30 s). |
courier.duty, courier.created, courier.updated, courier.deleted | Driver roster changes (fleet accounts). |
route.created, route.assigned, route.unassigned, route.started, route.updated, route.completed, route.delayed | Route lifecycle (route accounts). |
route.optimization_completed, route.batch_create_completed | Route building jobs finished. |
dispatch.auto_dispatch_completed, dispatch.failure | Automatic dispatch outcomes. |
sms.recipient_response_missed, sms.recipient_opt_out | The recipient texted back, or opted out of texts. |
refund.created, refund.updated | Refund requests. |
quote.created | A delivery was priced. |
Suggested subscriptions
| Use case | Subscribe to |
|---|---|
| Show status in your app | delivery.assigned_driver, delivery.pickup_complete, delivery.dropoff_complete, delivery.failed, delivery.canceled_by_* |
| Store proof of delivery | delivery.proof_of_delivery |
| Live map | courier_location.updated |
| Everything | delivery.* |
Something unclear or missing? Tell us.