List webhooks.

Return a paginated list of webhooks.

GET /api/hooks

Try it

List webhooks.

cURL

curl --request GET \
  --url https://{tenant}/api/hooks \
  --header 'Authorization: Bearer <token>'

200

{
  "hooks": [
    {
      "method": "POST",
      "target_path": "https://httpbin.org/expired-keys",
      "api_model": {},
      "event_timeout": 0,
      "header_map": {
        "secret": "superscretkey",
        "x-auth": "authvalue"
      },
      "id": "664b613f5715ec4c96cbef3e",
      "name": "Expired Keys webhook",
      "org_id": "5e9d9544a1dcd60001d0ed20",
      "template_path": "templates/default_webhook.json",
      "webhook_id": "1f78e319202b430e92286cff3ca759e3"
    }
  ],
  "pages": 123
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Query Parameters

p · integer

Use p query parameter to say which page you want returned. Send number less than 0 to return all items.

Response

200

application/json

Webhook fetched.

hooks · object[] | null

Show child attributes

hooks. method · string · required

Example:

"POST"

hooks. target_path · string · required

Example:

"https://httpbin.org/expired-keys"

hooks. api_model · object

hooks. event_timeout · integer<int64>

Example:

0

hooks. header_map · object

Show child attributes

hooks.header_map. {key} · string

Example:

{
  "secret": "superscretkey",
  "x-auth": "authvalue"
}

hooks. id · string

Example:

"664b613f5715ec4c96cbef3e"

hooks. name · string

Example:

"Expired Keys webhook"

hooks. org_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

hooks. template_path · string

Example:

"templates/default_webhook.json"

hooks. webhook_id · string

Example:

"1f78e319202b430e92286cff3ca759e3"

pages · integer