Webhook Notifications
Get a single webhook notification
Getting Started
In Depth Guides
Useful Info
Shipments
Tracking Requests
Tracking requests
Webhooks
Webhook Notifications
Containers
Shipping Lines
Terminals
Webhook Notifications
Get a single webhook notification
GET
/
webhook_notifications
/
{id}
Authorization
string
*
Authorization
Required
string
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
id
string
*
id
Required
string
include
string
include
string
Comma delimited list of relations to include.
{
"data": {
"id": "a76187fc-5749-43f9-9053-cfaad9790a31",
"type": "webhook_notification",
"attributes": {
"id": "a76187fc-5749-43f9-9053-cfaad9790a31",
"event": "tracking_request.succeeded",
"delivery_status": "pending",
"created_at": "2020-09-11T21:25:34Z"
},
"relationships": {
"reference_object": {
"data": {
"id": "bdeca506-9741-4ab1-a0a7-cfd1d908e923",
"type": "tracking_request"
}
},
"webhook": {
"data": {
"id": "914b21ce-dd7d-4c49-8503-65aba488e9a9",
"type": "webhook"
}
},
"webhook_notification_logs": {
"data": []
}
}
},
"included": [
{
"id": "bdeca506-9741-4ab1-a0a7-cfd1d908e923",
"type": "tracking_request",
"attributes": {
"request_number": "TE497ED1063E",
"request_type": "bill_of_lading",
"scac": "MSCU",
"ref_numbers": [],
"created_at": "2020-09-11T21:25:34Z",
"status": "created",
"failed_reason": null,
"is_retrying": false,
"retry_count": null
},
"relationships": {
"tracked_object": {
"data": {
"id": "b5b10c0a-8d18-46da-b4c2-4e5fa790e7da",
"type": "shipment"
}
}
},
"links": {
"self": "/v2/tracking_requests/bdeca506-9741-4ab1-a0a7-cfd1d908e923"
}
},
{
"id": "b5b10c0a-8d18-46da-b4c2-4e5fa790e7da",
"type": "shipment",
"attributes": {
"created_at": "2020-09-11T21:25:33Z",
"bill_of_lading_number": "TE497ED1063E",
"ref_numbers": [],
"shipping_line_scac": "MSCU",
"shipping_line_name": "Mediterranean Shipping Company",
"port_of_lading_locode": "MXZLO",
"port_of_lading_name": "Manzanillo",
"port_of_discharge_locode": "USOAK",
"port_of_discharge_name": "Port of Oakland",
"pod_vessel_name": "MSC CHANNE",
"pod_vessel_imo": "9710438",
"pod_voyage_number": "098N",
"destination_locode": null,
"destination_name": null,
"destination_timezone": null,
"destination_ata_at": null,
"destination_eta_at": null,
"pol_etd_at": null,
"pol_atd_at": "2020-08-29T21:25:33Z",
"pol_timezone": "America/Mexico_City",
"pod_eta_at": "2020-09-18T21:25:33Z",
"pod_ata_at": null,
"pod_timezone": "America/Los_Angeles"
},
"relationships": {
"port_of_lading": {
"data": {
"id": "4384d6a5-5ccc-43b7-8d19-4a9525e74c08",
"type": "port"
}
},
"port_of_discharge": {
"data": {
"id": "2a765fdd-c479-4345-b71d-c4ef839952e2",
"type": "port"
}
},
"pod_terminal": {
"data": {
"id": "17891bc8-52da-40bf-8ff0-0247ec05faf1",
"type": "terminal"
}
},
"destination": {
"data": null
},
"containers": {
"data": [
{
"id": "b2fc728c-e2f5-4a99-8899-eb7b34ef22d7",
"type": "container"
}
]
}
},
"links": {
"self": "/v2/shipments/b5b10c0a-8d18-46da-b4c2-4e5fa790e7da"
}
},
{
"id": "b2fc728c-e2f5-4a99-8899-eb7b34ef22d7",
"type": "container",
"attributes": {
"number": "ARDU1824900",
"seal_number": "139F1451",
"created_at": "2020-09-11T21:25:34Z",
"equipment_type": "dry",
"equipment_length": 40,
"equipment_height": "standard",
"weight_in_lbs": 53507,
"fees_at_pod_terminal": [],
"holds_at_pod_terminal": [],
"pickup_lfd": null,
"pickup_appointment_at": null,
"availability_known": true,
"available_for_pickup": false,
"pod_arrived_at": null,
"pod_discharged_at": null,
"final_destination_full_out_at": null,
"pod_full_out_at": null,
"empty_terminated_at": null,
"pod_timezone": "America/Los_Angeles",
"final_destination_timezone": null,
"empty_terminated_timezone": null
},
"relationships": {
"shipment": {
"data": {
"id": "b5b10c0a-8d18-46da-b4c2-4e5fa790e7da",
"type": "shipment"
}
},
"pod_terminal": {
"data": {
"id": "17891bc8-52da-40bf-8ff0-0247ec05faf1",
"type": "terminal"
}
},
"transport_events": {
"data": [
{
"id": "56078596-5293-4c84-9245-cca00a787265",
"type": "transport_event"
}
]
}
}
},
{
"id": "56078596-5293-4c84-9245-cca00a787265",
"type": "transport_event",
"attributes": {
"event": "container.transport.vessel_departed",
"created_at": "2020-09-11T21:25:34Z",
"voyage_number": null,
"timestamp": "2020-08-29T21:25:33Z",
"location_locode": "MXZLO",
"timezone": "America/Los_Angeles"
},
"relationships": {
"shipment": {
"data": {
"id": "b5b10c0a-8d18-46da-b4c2-4e5fa790e7da",
"type": "shipment"
}
},
"container": {
"data": {
"id": "b2fc728c-e2f5-4a99-8899-eb7b34ef22d7",
"type": "container"
}
},
"vessel": {
"data": null
},
"location": {
"data": {
"id": "2a765fdd-c479-4345-b71d-c4ef839952e2",
"type": "port"
}
},
"terminal": {
"data": null
}
}
}
]
}
Authorizations
Authorization
string
headerrequiredToken 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
id
string
requiredQuery Parameters
include
string
Comma delimited list of relations to include.
Response
200 - application/json
data
object
included
object[]
Was this page helpful?
{
"data": {
"id": "a76187fc-5749-43f9-9053-cfaad9790a31",
"type": "webhook_notification",
"attributes": {
"id": "a76187fc-5749-43f9-9053-cfaad9790a31",
"event": "tracking_request.succeeded",
"delivery_status": "pending",
"created_at": "2020-09-11T21:25:34Z"
},
"relationships": {
"reference_object": {
"data": {
"id": "bdeca506-9741-4ab1-a0a7-cfd1d908e923",
"type": "tracking_request"
}
},
"webhook": {
"data": {
"id": "914b21ce-dd7d-4c49-8503-65aba488e9a9",
"type": "webhook"
}
},
"webhook_notification_logs": {
"data": []
}
}
},
"included": [
{
"id": "bdeca506-9741-4ab1-a0a7-cfd1d908e923",
"type": "tracking_request",
"attributes": {
"request_number": "TE497ED1063E",
"request_type": "bill_of_lading",
"scac": "MSCU",
"ref_numbers": [],
"created_at": "2020-09-11T21:25:34Z",
"status": "created",
"failed_reason": null,
"is_retrying": false,
"retry_count": null
},
"relationships": {
"tracked_object": {
"data": {
"id": "b5b10c0a-8d18-46da-b4c2-4e5fa790e7da",
"type": "shipment"
}
}
},
"links": {
"self": "/v2/tracking_requests/bdeca506-9741-4ab1-a0a7-cfd1d908e923"
}
},
{
"id": "b5b10c0a-8d18-46da-b4c2-4e5fa790e7da",
"type": "shipment",
"attributes": {
"created_at": "2020-09-11T21:25:33Z",
"bill_of_lading_number": "TE497ED1063E",
"ref_numbers": [],
"shipping_line_scac": "MSCU",
"shipping_line_name": "Mediterranean Shipping Company",
"port_of_lading_locode": "MXZLO",
"port_of_lading_name": "Manzanillo",
"port_of_discharge_locode": "USOAK",
"port_of_discharge_name": "Port of Oakland",
"pod_vessel_name": "MSC CHANNE",
"pod_vessel_imo": "9710438",
"pod_voyage_number": "098N",
"destination_locode": null,
"destination_name": null,
"destination_timezone": null,
"destination_ata_at": null,
"destination_eta_at": null,
"pol_etd_at": null,
"pol_atd_at": "2020-08-29T21:25:33Z",
"pol_timezone": "America/Mexico_City",
"pod_eta_at": "2020-09-18T21:25:33Z",
"pod_ata_at": null,
"pod_timezone": "America/Los_Angeles"
},
"relationships": {
"port_of_lading": {
"data": {
"id": "4384d6a5-5ccc-43b7-8d19-4a9525e74c08",
"type": "port"
}
},
"port_of_discharge": {
"data": {
"id": "2a765fdd-c479-4345-b71d-c4ef839952e2",
"type": "port"
}
},
"pod_terminal": {
"data": {
"id": "17891bc8-52da-40bf-8ff0-0247ec05faf1",
"type": "terminal"
}
},
"destination": {
"data": null
},
"containers": {
"data": [
{
"id": "b2fc728c-e2f5-4a99-8899-eb7b34ef22d7",
"type": "container"
}
]
}
},
"links": {
"self": "/v2/shipments/b5b10c0a-8d18-46da-b4c2-4e5fa790e7da"
}
},
{
"id": "b2fc728c-e2f5-4a99-8899-eb7b34ef22d7",
"type": "container",
"attributes": {
"number": "ARDU1824900",
"seal_number": "139F1451",
"created_at": "2020-09-11T21:25:34Z",
"equipment_type": "dry",
"equipment_length": 40,
"equipment_height": "standard",
"weight_in_lbs": 53507,
"fees_at_pod_terminal": [],
"holds_at_pod_terminal": [],
"pickup_lfd": null,
"pickup_appointment_at": null,
"availability_known": true,
"available_for_pickup": false,
"pod_arrived_at": null,
"pod_discharged_at": null,
"final_destination_full_out_at": null,
"pod_full_out_at": null,
"empty_terminated_at": null,
"pod_timezone": "America/Los_Angeles",
"final_destination_timezone": null,
"empty_terminated_timezone": null
},
"relationships": {
"shipment": {
"data": {
"id": "b5b10c0a-8d18-46da-b4c2-4e5fa790e7da",
"type": "shipment"
}
},
"pod_terminal": {
"data": {
"id": "17891bc8-52da-40bf-8ff0-0247ec05faf1",
"type": "terminal"
}
},
"transport_events": {
"data": [
{
"id": "56078596-5293-4c84-9245-cca00a787265",
"type": "transport_event"
}
]
}
}
},
{
"id": "56078596-5293-4c84-9245-cca00a787265",
"type": "transport_event",
"attributes": {
"event": "container.transport.vessel_departed",
"created_at": "2020-09-11T21:25:34Z",
"voyage_number": null,
"timestamp": "2020-08-29T21:25:33Z",
"location_locode": "MXZLO",
"timezone": "America/Los_Angeles"
},
"relationships": {
"shipment": {
"data": {
"id": "b5b10c0a-8d18-46da-b4c2-4e5fa790e7da",
"type": "shipment"
}
},
"container": {
"data": {
"id": "b2fc728c-e2f5-4a99-8899-eb7b34ef22d7",
"type": "container"
}
},
"vessel": {
"data": null
},
"location": {
"data": {
"id": "2a765fdd-c479-4345-b71d-c4ef839952e2",
"type": "port"
}
},
"terminal": {
"data": null
}
}
}
]
}