Webhook eventsShipments
Shipment status updated
Sent when a shipment's status changes.
shipment.status.updatedHover a key to see what it means. Click it to jump to the field.
The first event for a new shipment has newShipmentStatus set to Unallocated and no previousShipmentStatus key, so treat that key as optional.
A shipment can jump ahead, for example when its carrier doesn't report every status. You still get an event for each status along the way, sent in lifecycle order, each with the status before it. A jump from DriverAllocated to EnrouteToDelivery sends three events:
previousShipmentStatus | newShipmentStatus |
|---|---|
DriverAllocated | EnrouteToPickup |
EnrouteToPickup | ArrivedAtPickup |
ArrivedAtPickup | EnrouteToDelivery |
The added events start at DriverAllocated and never include FindingDriver. A jump from Unallocated to EnrouteToPickup sends Unallocated to DriverAllocated, then DriverAllocated to EnrouteToPickup. A move back to an earlier status, or to Cancelled, sends one event.
Events can arrive out of order when one is retried. The event carries no time, and a step back is a real change, so don't drop an event because its status ranks below the one you have. When the current status matters, call Get shipment details.
Add shipment.status.updated to a configuration's subscribedEvents with Create a webhook configuration or in the dashboard.
Event data
data · 3 keysThe shipment's status now.
UnallocatedFindingDriverDriverAllocatedEnrouteToPickupArrivedAtPickupEnrouteToDeliveryArrivedAtDeliveryCompletedWhat each value means →The status before this change. Missing from the first event of a new shipment.
UnallocatedFindingDriverDriverAllocatedEnrouteToPickupArrivedAtPickupEnrouteToDeliveryArrivedAtDeliveryCompletedWhat each value means →can be missing