Types of events

The following is a list of all of Shipwell's event types and when they occurs.

These events follow a pattern: resource.event, and resource.sub-resource.event. If you don't currently see the event you would like, please send a note to support@shipwell.com and we will get it added.

NOTE on sub-resources

Events that occur on sub-resources like carrier_relationship.updated do not trigger the parent's update event. Instead, it triggers on the sub-resource itself.

To get the most up-to-date list of events available for webhooks use /events/event-names-by-version/

Event Description Event version
bill.created Occurs when any bill is created 1
bill.updated Occurs when a bill resource is updated 1
bill.creation_requested Occurs when a bill is requested from a tender 1
bill.line_item.updated Occurs when any line is updated on a bill resource 1

Carriers

Event Description Event version
carrier_relationship.created Occurs when a carrier is created 1
carrier_relationship.updated Occurs when a carrier is updated 1

Customer

Event Description Event version
customer_relationship.account_reps.updated Occurs when a customer's account representatives have been updated 1
customer_relationship.created Occurs when a customer is created 1
customer_relationship.sales_reps.updated Occurs when a customer's sales representative is update 1
customer_relationship.updated Occurs when any field is updated on the customer resource 1

Accounting Invoice

An Accounting Invoice is an invoice that is created and managed in a 3rd-party FMS. The 3rd-party FMS is the source of truth for an Accounting Invoice, and the object here is only used as a reference.

Event Description Event Version
invoice.created Occurs when an accounting invoice is created 2, 3
invoice.creation_requested Occurs when an accounting invoice is requested 1
invoice.line_item.created Occurs when any line item line is created on an accounting invoice resource 2, 3, 4
invoice.line_item.updated Occurs when any line item line is updated on an accounting invoice resource 1
invoice.send_email Occurs when an accounting invoice is sent to a related user's email 1
invoice.updated Occurs when any field on the accounting invoice resource changes 1

Freight Invoice

A Freight Invoice is an invoice that is created and managed within Shipwell. Shipwell is the source of truth for a Freight Invoice. Access to the individual events is dependent on whether you are the booking party or service provider on the invoice.

Event Description Event Version
freight_invoice.sent Occurs when a freight invoice is created. Only received by the service provider on the invoice. 1
freight_invoice.received Occurs when a freight invoice is created. Only received by the booking party on the invoice. 1
freight_invoice.sent.status_updated Occurs when the status of a freight invoice is updated. Only received by the service provider on the invoice. 1
freight_invoice.received.status_updated Occurs when the status of a freight invoice is updated. Only received by the booking party on the invoice. 1

Purchase order

Event Description Event Version
purchase_order.created Occurs when a purchase order is created 1
purchase_order.updated Occurs when any field on a purchase order resource is updated 1
purchase_order.deleted Occurs when a purchase order resource is deleted via the API, archiving the purchase ourder via the UI generates a purchase_order.updated event 1
purchase_order.line_item.created Occurs when any field on a purchase order line item resource is created 1

Shipment

Event Description Event Version
shipment.bol.created Occurs when a Bill of Lading is generated for a shipment 1
shipment.accessorials.updated Occurs when an Accessorial is updated for a shipment 1
shipment.charge_line_item.created Occurs when a shipment charge line item is created 1
shipment.charge_line_item.updated Occurs when a shipment charge line item is updated 1
shipment.created Occurs when a shipment is created 1
shipment.updated Occurs when a shipment is updated 1
shipment.dispatched Occurs when a Parcel shipment is dispatched and includes information specific to Parcel. To determine dispatched status for all other types of Shipments use shipment.status.updated 1
shipment.line_item.created Occurs when a shipment line item is created 1
shipment.line_item.updated Occurs when a shipment line item is updated 1
shipment.rep.created Occurs when a shipment representative (party) is created 1
shipment.status.updated Occurs when the status of a shipment is updated 1
shipment.stop.created Occurs when a shipment stop is created 1
shipment.stop.updated Occurs when a shipment stop is updated 1
shipment.timeline_event.created Occurs when a timeline event is created on a shipment 1
shipment.timeline_event.updated Occurs when the timeline on a shipment is updated 2
Copyright © Shipwell 2023. All right reserved.