Webhook Notifications
Get webhook notification payload examples
Returns an example payload as it would be sent to a webhook endpoint for the provided event
get/webhook_notifications/examples
Query parameters
event'container.transport.vessel_arrived' | 'container.transport.estimated.vessel_arrived' | 'container.transport.vessel_discharged' | 'container.transport.vessel_loaded' | 'container.transport.vessel_departed' | 'container.transport.estimated.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' | 'container.pickup_lfd_line.changed' | 'container.pickup_lfd_terminal.changed' | 'container.pickup_lfd_rail.changed' | 'container.pickup_appointment.changed' | 'container.transport.available' | 'container.transport.not_available' | 'container.transport.delivered' | 'document.extracted' | 'document.extraction_failed'
Example:container.transport.full_out
The webhook notification event name you wish to see an example of
Response
OK
Example response
{
"included": [
{
"attributes": {
"request_number": "ONEYSH9AME650500",
"request_type": "bill_of_lading",
"scac": "ONEY"
}
}
]
}