For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

claim.failed

This event is triggered when a filed insurance claim is unsuccessful.

claim.success

This event is triggered when a filed insurance claim is successful.

insurance.failed

This event is triggered when a purchase for insurance coverage fails.

insurance.pending

This event is triggered when insurance coverage is initiated for a shipment.

insurance.success

This event is triggered when insurance coverage is successfully 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.

reconciliation.billed

This event is triggered when a weight discrepancy is billed on a shipment.

reconciliation.flagged

This event is triggered when a weight discrepancy is flagged on a shipment.

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

Was this helpful?