Webhook Event Types
Below are a list of webhook events available with descriptions:
Event Type | Description |
---|---|
Shipment.Completed | Event triggered upon shipment completion. Shipment completion is determined by a set of organization preferences within the Freight Portal. Shipments can also be moved to completion via manual UI or API. |
Shipment.Created | Event triggered when shipment is created within Freight Portal. Shipments can be created in the Freight Portal UI or through the POST - Create Shipment |
Stop.Arrived | Event triggered when when a shipment has a stop arrival for any stop on the shipment. |
Stop.Departed | Event triggered when when a shipment has a stop departure for any stop on the shipment. |
Shipment.StatusUpdated | Event triggered when when a shipment status has changed. |
ExceptionPosted | Event triggered when when a shipment when a shipment has a new exception posted. |
PositionProcessed | Event triggered when when a shipment when a shipment has a new position event. |
TemperatureBreached | Event triggered when when a shipment when a shipment has a temperature that is outside of the provided range. Note that this does not take the organization preferences into consideration. |
Shipment.NoteAdded | Event triggered when a note is added to a shipment. |
Shipment.DocumentAdded | Event triggered when a document is added to a shipment. |
Shipment.StopNoteAdded | Event triggered when a stop note is added to the shipment from the Mobile API. |
Exception.Updated | Exception has been updated, including when a file has been added. |
Accessorial.Added | An Accessorial was added. |
Accessorial.Updated | An Accessorial was updated. |
Accessorial.Deleted | An Accessorial was removed. |
Appointment.Updated | Event triggered when an appointment has been updated or added to a shipment stop. |
StopETABaselineChanged | The ETA baseline for a Stop has been changed. |
Shipment.AssetUpdated | The Tractor or Trailer assignment for a Shipment has been changed. |
Shipment.Updated | Any update to a shipment not covered by other trigger types |
Updated about 2 months ago