Webhook Events
Representative payloads for webhook deliveries First sends to your configured URL. Examples are redacted and modeled on current production field patterns; provider-specific optional fields can vary.
Typical lifecycle:
scheduled → en_route_pickup → arrived_pickup → en_route_dropoff → arrived_dropoff → completed
Alternate events include cancelled, reassign, and Refunded. ready_now is an opt-in event layered on the current lifecycle status, so route it using event: "ready_now", not status_v3.
Every new payload includes trackerLinkFleet and fleetName; either may be null. Driver, location, ETA, fee, proof-of-delivery, cancellation, and provider tracker fields are conditional.
Webhook delivery is not exactly once or ordered. Return 2xx quickly after durable enqueue, process idempotently, treat optional fields defensively, and reconcile critical order state through polling. Custom headers configured in http_options.headers are sent with Content-Type: application/json.
Endpoints
Section titled “Endpoints”- POST Order Scheduled (scheduled)
- POST Driver Assigned (en_route_pickup)
- POST Arrived at Pickup (arrived_pickup)
- POST Picked Up (en_route_dropoff)
- POST Arrived at Dropoff (arrived_dropoff)
- POST Delivered (completed)
- POST Cancelled (cancelled)
- POST Reassigned (reassign)
- POST Refunded (Refunded)
- POST Ready Now (ready_now)