Webhook Events
Here you can find a list of webhook event types along with descriptions of each event.
Event | Description |
---|---|
address.created | This event is triggered when a new address is created. |
address.deleted | This event is triggered when an address is deleted. |
address.updated | This event is triggered when an existing address is updated. |
insurance.failed | This event is triggered when a purchase for insurance coverage fails. |
insurance.success | This event is triggered when insurance coverage is purchased for a shipment. |
packaging.created | This event is triggered when a new packaging is created. |
packaging.updated | This event is triggered when packaging information is updated. |
shipment.cancelled | This event is triggered when a shipment is cancelled. |
shipment.created | This event is triggered when a new shipment is created. |
shipment.in-transit | This event is triggered only once when a new shipment is in-transit. |
shipment.updated | This event is triggered when an active shipment is updated. e.g. Shipment is picked up by rider. |
shipment.delivered | This event is triggered when a shipment is delivered. e.g, Shipment delivered to destination address |
transaction.success | This event is triggered when the transaction charge for a shipment is successful. |
transaction.failed | This event is triggered when the transaction charge for a shipment fails. |
Last updated