List webhook notifications

Return the list of webhook notifications. This can be useful for reconciling your data if your endpoint has been down.

GET /webhook_notifications

List webhook notifications

cURL

curl --request GET \
  --url https://api.terminal49.com/v2/webhook_notifications \
  --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

page[number] · integer

page[size] · integer

include · string

Comma delimited list of relations to include.

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