Skip to main content

Shipment Webhooks

Actions​

You can subscribe to the following actions:

  • shipment.created
  • shipment.updated
  • shipment.deleted
  • shipment.updated.status

Review webhooks to learn how to use these actions.

Use Cases​

Here are some recommended setups for common flows.

Notify when Shipment Ships​

If you would like to be notified of an incoming shipment (i.e. Advance Ship Notice on its way) then follow the below configuration.

Configuration​

Configure your webhook to subscribe to shipment.updated.status and shipment.created actions.

You will receive notifications for all new shipments being created and all shipment status changes.

The shipment status you will be looking for is shipped. A shipment can be created in shipped status or an existing shipment can have status changed from unshipped to shipped.

You will need to filter out updates in an unwanted status. You can do this within your system or by creating a transformation your Webhook Portal. See Webhook Advanced for more details.

Notify when existing Shipment Closes​

If you would like to be notified of a shipment closing (i.e. Advance Ship Notice was fully received) then follow the below configuration.

Configuration​

Configure your webhook to subscribe to shipment.updated.status action.

You will receive notifications for all shipment status changes.

The shipment status you will be looking for is closed.

You will need to filter out updates in an unwanted status. You can do this within your system or by creating a transformation your Webhook Portal. See Webhook Advanced for more details.