Based on the events that you subscribe to when you configure webhooks, Delivery Hub sends updates in payloads that contain all the information used in the shipment model. This updates the data in your other system with the data created in Delivery Hub.
Webhook | Trigger Event |
---|---|
Shipment created | A new shipment has been created in Delivery Hub. Status: New |
(Coming soon) Shipment ready for pick up | A carrier has been booked for this shipment. Status: Ready to Ship |
Shipment picked up | The carrier has picked up the shipment. Status: Picked Up |
Shipment in transit | The shipment is on its journey to the customer. Status: In Transit |
Shipment out for delivery | The shipment is with a driver and is scheduled to be delivered on the same day. Status: Out for Delivery |
Shipment delivered | The shipment has been delivered to the customer's address. Status: Delivered |
Shipment exception | There is a delay or other problem with the shipment. Carriers usually include more details, which are included as a description in this webhook. Status: Exception |
(Coming soon) Return created | The customer has created a return. |
(Coming soon) Return picked up | The customer has dropped off the return with the carrier, or the carrier has picked it up from the customer. |
(Coming soon) Return in transit | The return is on its journey back to the shipping location. |
(Coming soon) Return out for delivery | The return is with a driver and is scheduled to arrive at the shipping location on the same day. |
(Coming soon) Return delivered | The return has been received at the shipping location. |
(Coming soon) Return exception | There is a delay or other problem with the shipment. Carriers usually include more details, which are included as a description in this webhook. |
(Coming soon) Shipment rejected by carrier | - The manually assigned carrier has rejected the shipment. - When Shipping Rules are active and the shipment meets the conditions for a rule: all carriers listed as options have rejected the shipment. |