Get webhook notification payload examples

Returns an example payload as it would be sent to a webhook endpoint for the provided event

GET /webhook_notifications/examples

Get webhook notification payload examples

cURL

curl --request GET \
  --url https://api.terminal49.com/v2/webhook_notifications/examples \
  --header 'Authorization: <api-key>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "delivery_status": "pending",
        "created_at": "<string>"
      },
      "relationships": {
        "webhook": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "reference_object": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  },
  "included": [
    {
      "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

Query Parameters

event · enum<string>

The webhook notification event name you wish to see an example of

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

Example:

"container.transport.full_out"

Response

200 - application/json

OK

data · webhook_notification · object[]

Show child attributes

links · links · object

Show child attributes

meta · meta · object

Show child attributes

included · (webhook · object | Tracking Request · object | Transport Event Model · object | Estimated Event Model · object)[]

webhook

Tracking Request

Transport Event Model

Estimated Event Model

Show child attributes