Webhooks
List webhooks
Getting Started
In Depth Guides
Useful Info
Shipments
Tracking Requests
Webhooks
Webhook Notifications
Containers
Shipping Lines
Terminals
Webhooks
List webhooks
Get a list of all the webhooks
GET
/
webhooks
curl --request GET \
--url https://api.terminal49.com/v2/webhooks \
--header 'Authorization: <api-key>'
{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "webhook",
"attributes": {
"url": "http://example.com",
"active": true,
"events": [
"tracking_request.succeeded"
],
"secret": "672bd7b58b54645934a830d8fa",
"headers": [
{
"name": "x-secret-sauce",
"value": "sriracha"
}
]
}
}
],
"meta": {
"size": 0,
"total": 0
},
"links": {
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com",
"first": "http://example.com",
"self": "http://example.com"
}
}
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
Response
200 - application/json
OK
Available options:
webhook
https end point
Whether the webhook will be delivered when events are triggered
The list of events to enabled for this endpoint
Available options:
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?
curl --request GET \
--url https://api.terminal49.com/v2/webhooks \
--header 'Authorization: <api-key>'
{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "webhook",
"attributes": {
"url": "http://example.com",
"active": true,
"events": [
"tracking_request.succeeded"
],
"secret": "672bd7b58b54645934a830d8fa",
"headers": [
{
"name": "x-secret-sauce",
"value": "sriracha"
}
]
}
}
],
"meta": {
"size": 0,
"total": 0
},
"links": {
"last": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com",
"first": "http://example.com",
"self": "http://example.com"
}
}