Getting Started
In Depth Guides
Useful Info
Shipments
Tracking Requests
Tracking requests
Webhooks
Webhook Notifications
Containers
Shipping Lines
Terminals
Edit a webhook
Update a single webhook
Token YOUR_API_TOKEN
The APIs require authentication to be done using header-based API Key and Secret Authentication.
API key and secret are sent va the Authorization request header.
You send your API key and secret in the following way:
Authorization: Token YOUR_API_KEY
The URL of the webhook endpoint.
The list of events to enable for this endpoint.
Optional custom headers to pass with each webhook invocation
Authorizations
Token YOUR_API_TOKEN
The APIs require authentication to be done using header-based API Key and Secret Authentication.
API key and secret are sent va the Authorization request header.
You send your API key and secret in the following way:
Authorization: Token YOUR_API_KEY
Path Parameters
Body
The URL of the webhook endpoint.
The list of events to enable for this endpoint.
container.transport.vessel_arrived, container.transport.vessel_discharged, container.transport.vessel_loaded, container.transport.vessel_departed, container.transport.rail_departed, container.transport.rail_arrived, container.transport.rail_loaded, container.transport.rail_unloaded, container.transport.transshipment_arrived, container.transport.transshipment_discharged, container.transport.transshipment_loaded, container.transport.transshipment_departed, container.transport.feeder_arrived, container.transport.feeder_discharged, container.transport.feeder_loaded, container.transport.feeder_departed, container.transport.empty_out, container.transport.full_in, container.transport.full_out, container.transport.empty_in, container.transport.vessel_berthed, shipment.estimated.arrival, tracking_request.succeeded, tracking_request.failed, tracking_request.awaiting_manifest, tracking_request.tracking_stopped, container.created, container.updated, container.pod_terminal_changed, container.transport.arrived_at_inland_destination, container.transport.estimated.arrived_at_inland_destination, container.pickup_lfd.changed webhook Response
webhook https end point
Whether the webhook will be delivered when events are triggered
The list of events to enabled for this endpoint
container.transport.vessel_arrived, container.transport.vessel_discharged, container.transport.vessel_loaded, container.transport.vessel_departed, container.transport.rail_departed, container.transport.rail_arrived, container.transport.rail_loaded, container.transport.rail_unloaded, container.transport.transshipment_arrived, container.transport.transshipment_discharged, container.transport.transshipment_loaded, container.transport.transshipment_departed, container.transport.feeder_arrived, container.transport.feeder_discharged, container.transport.feeder_loaded, container.transport.feeder_departed, container.transport.empty_out, container.transport.full_in, container.transport.full_out, container.transport.empty_in, container.transport.vessel_berthed, shipment.estimated.arrival, tracking_request.succeeded, tracking_request.failed, tracking_request.awaiting_manifest, tracking_request.tracking_stopped, container.created, container.updated, container.pod_terminal_changed, container.transport.arrived_at_inland_destination, container.transport.estimated.arrived_at_inland_destination, container.pickup_lfd.changed A random token that will sign all delivered webhooks
Was this page helpful?