Types of events
The following is a list of all of Shipwell's event types and when they occur.
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 make a GET request to the /events/event-names-by-version/ endpoint as documented here.
Bill
| 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 that is connected via the Shipwell marketplace. Currently, the FMS systems available are NetSuite and QuickBooks. The 3rd-party FMS is the source of truth for an Accounting Invoice, and the object here is only used as a reference. Note Accounting Invoices are different than Freight Invoices within Shipwell. If connecting your FMS separately to Shipwell through its public APIs then this is through Freight Invoices and you should look for the Freight Invoice events below.
| 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 |
Orders (Next Generation)
Note
These events are for customers that have opted-in to the new modern orders framework and Orders API. For example, customers with access to Supplier Portal will have access to these order event payloads. If you are an existing Shipwell customer and want to migrate to the new Orders API, contact your customer service representative. If you want to learn more as a new Shipwell customer contact sales here.
Order
These events occur for purchase orders, sales orders and other order types in the new modern orders framework and Orders API.
| Event | Description | Event Version |
|---|---|---|
order.created |
Occurs when an order is created | 1 |
order.updated |
Occurs when any field on an order resource is updated. This includes when an order is canceled. | 1 |
order.item.updated |
Occurs when any field on an order line item resource is updated | 1 |
order.item.deleted |
Occurs when an order line item resource is deleted from the order | 1 |
Transportation Release
| Event | Description | Event Version |
|---|---|---|
transportation_release.assigned |
Occurs when a transportation release is assigned | 1 |
transportation_release.unassigned |
Occurs when a transportation release is unassigned | 1 |
transportation_release.item.assigned |
Occurs when an item is assigned to a transportation release | 1 |
transportation_release.item.unassigned |
Occurs when an item is unassigned from transportation release | 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.charge_line_item.carrier_added |
Occurs when a shipment has a financial charge line item added by a carrier | 1 |
shipment.charge_line_item.carrier_updated |
Occurs when a shipment has a financial charge line item updated by a carrier | 1 |
shipment.carrier_assigned |
Occurs when a shipment is assigned a carrier | 1 |
shipment.carrier_removed |
Occurs when a shipment carrier assignment is removed | 1 |
shipment.document.created |
Occurs when a shipment document is created | 1 |
shipment.document.updated |
Occurs when a shipment document 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.stop.location.updated |
Occurs when a shipment stop location is updated on a stop | 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 |
RFQ
| Event | Description | Event Version |
|---|---|---|
rqf.did_finish_autoquote |
Occurs when an RFQ (Request for Quote) is finished autoquoting | 1 |
Dock Scheduling Appointment
| Event | Description | Event Version |
|---|---|---|
appointment.created |
Occurs when an appointment is created | 1 |
appointment.scheduled |
Occurs when an appointment is scheduled | 1 |
appointment.rescheduled |
Occurs when an appointment is rescheduled | 1 |
appointment.cancelled |
Occurs when an appointment is cancelled | 1 |
Purchase Order
Note
The events grouped under this section are for Shipwell's Orders (Legacy/v2) API. If you are a new Shipwell customer or use the modern Orders (Next Generation) framework, use these order events.
| 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 |
purchase_order.line_item.updated |
Occurs when any field on a purchase order line item resource is updated | 1 |
purchase_order.line_item.deleted |
Occurs when any field on a purchase order line item resource is deleted | 1 |
purchase_order.attached_with_shipment |
Occurs when an order is added or attached to a shipment | 1 |
purchase_order.detached_from_shipment |
Occurs when an order is removed or detached from a shipment | 1 |