Webhooks Catalog Based on Status Names
Clients can subscribe to receive webhooks based on the following status names. Choose the statuses you wish to monitor and configure your webhook to receive notifications when a status change occurs.
| Status Name | Description |
|---|---|
initialState | The shipment's initial state |
draft | The shipment has been created as a draft |
confirmed | The shipment has been confirmed by the system |
readyToPickup | The shipment is ready for pickup |
onRoadToPickup | The shipment is on the way for pickup |
collected | The shipment has been collected |
unsuccessfulPickup | The pickup attempt was unsuccessful |
stored | The shipment is stored |
onContainer | The shipment is loaded onto a container |
chargedToVehicle | The shipment has been charged to a vehicle |
onLinehaul | The shipment is on the linehaul |
onRoadToDelivery | The shipment is on the way to delivery |
delivered | The shipment has been successfully delivered |
unsuccessfulDelivery | The delivery attempt was unsuccessful |
onRoadToReturn | The shipment is on the way to be returned |
returned | The shipment has been returned |
driverAssignedToPickUp | A driver has been assigned to pick up the shipment |
unsuccessfulReturn | The return attempt was unsuccessful |
inPoint99 | The shipment is in a near-final state before return |
readyToReturn | The shipment is ready to be returned |
potentiallyDelivery | The shipment is potentially going to be delivered |
potentiallyReturn | The shipment is potentially going to be returned |
potentiallyWarehouse | The shipment is potentially headed to a warehouse |
potentiallyLost | The shipment is potentially lost |
onCostumerReview | The shipment is under customer review |
claimed | The shipment has been claimed |
ended | The shipment process has ended |
inCorrection | The shipment is undergoing corrections |
corrected | The shipment has been corrected |
maxDeliveryAttempts | Maximum delivery attempts reached |
maxReturnAttempts | Maximum return attempts reached |
stolen | The shipment has been marked as stolen |
lost | The shipment has been lost |
cancelled | The shipment has been cancelled |
damaged | The shipment has been damaged |
invalidAddress | The shipment has an invalid address |
indeterminateClosure | The shipment closure is indeterminate |
draftCancelledByUser | The draft shipment has been cancelled by the user |
maxPickupAttempts | Maximum pickup attempts reached |
draftArchived | The draft shipment has been archived |
inUpdates:PACKAGE_RESIZING | The shipment is being updated with package resizing |
inUpdates:ADDRESS_FIXER | The shipment is being updated with an address correction |
This catalog allows clients to define and manage the webhooks they want to receive based on specific shipment statuses.