curl --request GET \
--url https://api.terminal49.com/v2/webhook_notifications \
--header 'Authorization: <api-key>'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "webhook_notification",
"attributes": {
"event": "container.transport.vessel_arrived",
"delivery_status": "pending",
"created_at": "<string>"
},
"relationships": {
"webhook": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "webhook"
}
},
"reference_object": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "tracking_request"
}
}
}
}
],
"links": {
"last": "<string>",
"next": "<string>",
"prev": "<string>",
"first": "<string>",
"self": "<string>"
},
"meta": {
"size": 123,
"total": 123
},
"included": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "webhook",
"attributes": {
"url": "<string>",
"active": true,
"events": [
"container.transport.vessel_arrived"
],
"secret": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
]
}
}
]
}Return the list of webhook notifications. This can be useful for reconciling your data if your endpoint has been down.
curl --request GET \
--url https://api.terminal49.com/v2/webhook_notifications \
--header 'Authorization: <api-key>'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "webhook_notification",
"attributes": {
"event": "container.transport.vessel_arrived",
"delivery_status": "pending",
"created_at": "<string>"
},
"relationships": {
"webhook": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "webhook"
}
},
"reference_object": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "tracking_request"
}
}
}
}
],
"links": {
"last": "<string>",
"next": "<string>",
"prev": "<string>",
"first": "<string>",
"self": "<string>"
},
"meta": {
"size": 123,
"total": 123
},
"included": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "webhook",
"attributes": {
"url": "<string>",
"active": true,
"events": [
"container.transport.vessel_arrived"
],
"secret": "<string>",
"headers": [
{
"name": "<string>",
"value": "<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
Comma delimited list of relations to include.
OK
Show child attributes
webhook_notification Show child attributes
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, container.pickup_lfd_line.changed, container.transport.available Whether the notification has been delivered to the webhook endpoint
pending, succeeded, failed Show child attributes
Show child attributes
webhook Show child attributes
https end point
Whether the webhook will be delivered when events are triggered
The list of events to enabled for this endpoint
1container.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, container.pickup_lfd_line.changed, container.transport.available A random token that will sign all delivered webhooks
Was this page helpful?