Webhooks
Edit a webhook
Getting Started
In Depth Guides
Useful Info
Shipments
Tracking Requests
Webhooks
Webhook Notifications
Containers
Shipping Lines
Terminals
Webhooks
Edit a webhook
Update a single webhook
PATCH
/
webhooks
/
{id}
curl --request PATCH \
--url https://api.terminal49.com/v2/webhooks/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"attributes": {
"url": "https://webhook.site/#!/39084fbb-d887-42e8-be08-b9183ad02362",
"events": [
"container.transport.vessel_arrived"
],
"active": true,
"headers": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"type": "webhook"
}
}'{
"data": {
"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>"
}
]
}
}
}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
application/json
The URL of the webhook endpoint.
Example:
"https://webhook.site/#!/39084fbb-d887-42e8-be08-b9183ad02362"
The list of events to enable 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, container.transport.available Available options:
webhook 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, container.transport.available A random token that will sign all delivered webhooks
Was this page helpful?
curl --request PATCH \
--url https://api.terminal49.com/v2/webhooks/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"attributes": {
"url": "https://webhook.site/#!/39084fbb-d887-42e8-be08-b9183ad02362",
"events": [
"container.transport.vessel_arrived"
],
"active": true,
"headers": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"type": "webhook"
}
}'{
"data": {
"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>"
}
]
}
}
}