New webhook event — pickup.vehicle_location.changed
New webhook event — pickup.vehicle_location.changed
Retailers can now subscribe to pickup.vehicle_location.changed to receive
real-time vehicle position updates while a delivery is in transit. The
pickup_status.changed payload has also been extended with an optional
vehicle_location field for subscribers to the new event.
Added
pickup.vehicle_location.changed webhook event
Fired on two triggers while a delivery is in the active window
(EN_ROUTE_TO_STORE through EN_ROUTE_TO_CUSTOMER):
- Movement-driven — the vehicle has moved approximately 50 meters since the previous emit.
- Heartbeat — at least 60 seconds have passed since the previous emit, even if the vehicle is stationary.
The event stops firing automatically once the delivery transitions to a
terminal status (ARRIVED_AT_CUSTOMER, COMPLETED, FAILED, CANCELLED).
No per-delivery cleanup is required on your end.
Payload:
Subscribe by including the event in your registration or update call:
Changed
pickup_status.changed now includes optional vehicle_location
If your webhook is subscribed to pickup.vehicle_location.changed, the
pickup_status.changed payload now includes a vehicle_location field with
the vehicle’s position at the moment of the status transition. The field is
either an object (fresh fix within the last 5 minutes), null (subscribed
but no fresh fix or no vehicle assigned yet), or omitted entirely (not
subscribed to the location event).
This is a non-breaking, additive change — existing integrations that haven’t
subscribed to pickup.vehicle_location.changed see no change in payload shape.
Notes
- Webhook delivery is at-least-once with no cross-type ordering guarantee. A
pickup.vehicle_location.changedevent may arrive shortly after a terminalpickup_status.changedfor the same delivery — reconcile via thetimestampfield rather than receive-order. recorded_atinsidevehicle_locationmay lag the outer eventtimestampby a few seconds (it reflects when the GPS sample was taken on-vehicle, not when the webhook fired).