Skip to main content
GET
/
api
/
hooks
List webhooks.
curl --request GET \
  --url https://{tenant}/api/hooks \
  --header 'Authorization: Bearer <token>'
{
  "hooks": [
    {
      "api_model": {},
      "event_timeout": 0,
      "header_map": {
        "secret": "superscretkey",
        "x-auth": "authvalue"
      },
      "id": "363634393863643165326663643130303031383465636239",
      "method": "POST",
      "name": "Expired Keys webhook",
      "org_id": "5e9d9544a1dcd60001d0ed20",
      "target_path": "https://httpbin.org/expired-keys",
      "template_path": "",
      "webhook_id": "1f78e319202b430e92286cff3ca759e3"
    },
    {
      "api_model": {},
      "event_timeout": 0,
      "header_map": {
        "x-auth": "keith"
      },
      "id": "363634623338353335373135656334633936636265663364",
      "method": "POST",
      "name": "Webhook Receiver Post",
      "org_id": "5e9d9544a1dcd60001d0ed20",
      "target_path": "https://httpbin.org/receiver",
      "template_path": "",
      "webhook_id": "9aef65505d694792a25fd0334dde2661"
    }
  ],
  "pages": 1
}

​
Authentication

✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

​
Required Permissions

Webhooks:Read: Always required.

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

Webhook fetched.

​
hooks
object[] | null
​
pages
integer