Create a webhook

You can configure a webhook via the API to be notified about events that happen in your Terminal49 account. These events can be realted to tracking_requests, shipments and containers.

This is the recommended way tracking shipments and containers via the API. You should use this instead of polling our the API periodically.

POST /webhooks

Create a webhook

cURL

curl --request POST \
  --url https://api.terminal49.com/v2/webhooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "url": "https://webhook.site/",
      "events": [
        "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"
      ],
      "active": true
    },
    "type": "webhook"
  }
}
'

201

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {
      "url": "<string>",
      "active": true,
      "events": [],
      "secret": "<string>",
      "headers": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

data · object · required

Show child attributes

Response

201

application/json

Create a test webhook endpoint

data · webhook · object

Show child attributes