Find below the list of supported events for our Webhook API and the corresponding triggers.
Deep dive into the each event format (schema and examples) in our event documentation
Operationnal Webhooks (meta-events)
Those webhooks are self sufficient to use Webhook API as a PUSH API.
They are sent only once per shipment (not once per container) and the payload contains the information for the whole shipment.
| Event Type | Trigger | Comment |
|---|---|---|
shipment.added.to.endpoint |
We have received the first tracking data for this container |
Sent once, short after POST shipment request. |
shipment.in.error |
We haven't received any data for this shipment, and it has been added for more than 24h. |
Sent once per shipment, short after POST shipment request. |
shipment.any.change |
One or several events of your shipment have changed since the last update. |
Sent once for all containers in the shipment, will be sent anytime a change is detected. |
shipment.auto.removed |
Your shipment has been auto removed srom you tracked shipment. |
Sent once at shipment auto removal. |
Alerts raised for specific triggers
| Event Type | Trigger | Related status field | Related eventCode | Related Location type |
|---|---|---|---|---|
| container.departure.from.final.pod | isActual has moved to true for the event | CGO | GTOT | POD |
| container.discharge.at.final.pod | isActual has moved to true for the event | CDD | DISC | POD |
| container.discharge.at.transhipment_port | isActual has moved to true for the event | CDT | DISC | transhipment |
| container.loaded.at.first.pol | isActual has moved to true for the event | CLL | LOAD | POL |
| vessel.departure.from.transhipment_port | isActual has moved to true for the event | VDT | DEPA | transhipment |
| container.arrival.at.first.pol | isActual has moved to true for the event | CGI | GTIN | POL |
| container.loaded.at.transhipment_port | isActual has moved to true for the event | CLT | LOAD | transhipment |
| vessel.arrival.at.final.pod | isActual has moved to true for the event | VAD | ARRI | POD |
| vessel.arrival.at.transhipment_port | isActual has moved to true for the event | VAT | ARRI | transhipment |
| vessel.departure.from.first.pol | isActual has moved to true for the event | VDL | DEPA | POL |
| container.loaded.at.pre.pol | isActual has moved to true for the event | LOAD | prePOL | |
| container.discharge.at.post.pod | isActual has moved to true for the event | DISC | postPOD | |
| container.departure.from.pre.pol | isActual has moved to true for the event | DEPA | prePOL | |
| container.arrival.at.pre.pol | isActual has moved to true for the event | ARRI | prePOL | |
| container.departure.from.post.pod | isActual has moved to true for the event | DEPA | postPOD | |
| container.arrival.at.post.pod | isActual has moved to true for the event | ARRI | postPOD | |
| date.changed.container.departure.from.final.pod | Date has changed from more than 24h (positive or negative) since the previous alert sent | CGO | GTOT | POD |
| date.changed.container.discharge.at.final.pod | Date has changed from more than 24h (positive or negative) since the previous alert sent | CDD | DISC | POD |
| date.changed.container.discharge.at.transhipment_port | Date has changed from more than 24h (positive or negative) since the previous alert sent | CDT | DISC | transhipment |
| date.changed.container.loaded.at.first.pol | Date has changed from more than 24h (positive or negative) since the previous alert sent | CLL | LOAD | POL |
| date.changed.vessel.arrival.at.final.pod | Date has changed from more than 24h (positive or negative) since the previous alert sent | VAD | ARRI | POD |
| date.changed.vessel.arrival.at.transhipment_port | Date has changed from more than 24h (positive or negative) since the previous alert sent | VAT | ARRI | transhipment |
| date.changed.vessel.departure.from.first.pol | Date has changed from more than 24h (positive or negative) since the previous alert sent | VDL | DEPA | POL |
| date.changed.vessel.departure.from.transhipment_port | Date has changed from more than 24h (positive or negative) since the previous alert sent | VDT | DEPA | transhipment |
| date.changed.container.arrival.at.first.pol | Date has changed from more than 24h (positive or negative) since the previous alert sent | CGI | GTIN | POL |
| date.changed.container.loaded.at.transhipment_port | Date has changed from more than 24h (positive or negative) since the previous alert sent | CLT | LOAD | transhipment |
| date.changed.container.arrival.at.pre.pol | Date has changed from more than 24h (positive or negative) since the previous alert sent | ARRI | prePOL | |
| date.changed.container.departure.from.pre.pol | Date has changed from more than 24h (positive or negative) since the previous alert sent | DEPA | prePOL | |
| date.changed.container.loaded.at.pre.pol | Date has changed from more than 24h (positive or negative) since the previous alert sent | LOAD | prePOL | |
| date.changed.container.discharge.at.post.pod | Date has changed from more than 24h (positive or negative) since the previous alert sent | DISC | postPOD | |
| date.changed.container.arrival.at.post.pod | Date has changed from more than 24h (positive or negative) since the previous alert sent | ARRI | postPOD | |
| date.changed.container.departure.from.post.pod | Date has changed from more than 24h (positive or negative) since the previous alert sent | DEPA | postPOD | |
| container.new.event.detected | A new event (single event rule = same status, eventCode and location.unlocode) has been detected for this container |