List webhooks

List every webhook subscription configured for your Terminal49 account, including each endpoint URL, subscribed event types, and active status flag.

GET /webhooks

List webhooks

cURL

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

200

{
  "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

Authorization · string · header · required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Query Parameters

page[number] · integer

page[size] · integer

Response

200 - application/json

OK

data · webhook · object[]

Show child attributes

meta · meta · object

Show child attributes

links · links · object

Show child attributes