---
title: "List Webhooks"
method: GET
path: "/api/v2/webhooks"
tags: ["Webhooks"]
---

# List Webhooks

`GET /api/v2/webhooks`

List webhooks.

## Query parameters

- `page[before]` string
- `page[after]` string
- `page[size]` integer
- `filter[name_contains]` string
- `filter[status]` 'active' | 'inactive'
- `sort` 'name' | 'status'

## Response `200`

Successful response

- WebhookListResponse
  - `webhooks` Webhook[]
    - `id` string — An auto-generated webhook id
    - `name` string, required — Webhook name
    - `description` string — Webhook description
    - `endpoint` string, required — The destination URL that the webhook notifies when Zendesk events occur
    - `http_method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', required — HTTP method used for the webhook's requests. To subscribe the webhook to Zendesk events, this must be "POST"
    - `request_format` 'json' | 'xml' | 'form_encoded', required — The format of the data that the webhook will send. To subscribe the webhook to Zendesk events, this must be "json"
    - `status` 'active' | 'inactive', required — Current status of the webhook
    - `subscriptions` string[] — Event subscriptions for the webhook. To subscribe the webhook to Zendesk events, specify one or more event types. To connect the webhook to a trigger or automation, specify only "conditional_ticket_events" in the array
    - `authentication` union — Adds authentication to the webhook's HTTP requests, if not specified, the webhook will be unauthenticated
      - BasicAuthAuthentication — Basic authentication configuration
        - `type` 'basic_auth', required
        - `data` object
          - `username` string, required — Username for basic authentication
          - `password` string — Password for basic authentication
      - BearerTokenAuthentication — Bearer token authentication configuration
        - `type` 'bearer_token', required
        - `data` object
          - `token` string — Bearer token for authentication
      - ApiKeyAuthentication — API key authentication configuration
        - `type` 'api_key', required
        - `data` object
          - `name` string, required — Name of the API key parameter
          - `value` string — Value of the API key
        - `add_position` 'header' | 'query_string', required — Where to add the API key (header or query string)
    - `custom_headers` object — Custom headers to deliver additional non-credential info to destinations
    - `signing_secret` WebhookSigningSecret — Signing secret used to verify webhook requests
      - `algorithm` string — Signing algorithm (e.g., sha256)
      - `secret` string — The signing secret value
    - `external_source` object — External source by which a webhook is created, e.g. Zendesk Marketplace
      - `name` string — Name of the external source
      - `version` string — Version of the external source
    - `created_at` string, date-time — When the webhook was created
    - `created_by` string — id of the user who created the webhook. "-1" represents the Zendesk system
    - `updated_at` string, date-time — When the webhook was last updated
    - `updated_by` string — id of the user who last updated the webhook
  - `meta` PaginationMeta
    - `has_more` boolean — Whether there are more results available
    - `after_cursor` string — Cursor for the next page of results
    - `before_cursor` string — Cursor for the previous page of results
    - `count` integer — Total number of items (may not always be present)
  - `links` PaginationLinks
    - `prev` string, uri — URL for the previous page of results
    - `next` string, uri — URL for the next page of results

## Changes

> 29 revisions in range; 1 not diffed.

- **2026-05-11** `a67ea66f0a52` — 3 breaking
  - the response property `webhooks/items/authentication/oneOf[#/components/schemas/ApiKeyAuthentication]/data` became optional for the status `200`
  - the response property `webhooks/items/authentication/oneOf[#/components/schemas/BasicAuthAuthentication]/data` became optional for the status `200`
  - the response property `webhooks/items/authentication/oneOf[#/components/schemas/BearerTokenAuthentication]/data` became optional for the status `200`
- **2025-06-12** `9eac011b0efd` — 3 breaking, 2 warning, 1 info
  - for the `query` request parameter `page[size]`, default value `100` was added
  - for the `query` request parameter `page[size]`, the type/format was changed from `string`/`` to `integer`/``
  - added `#/components/schemas/BasicAuthAuthentication, #/components/schemas/BearerTokenAuthentication, #/components/schemas/ApiKeyAuthentication` to the `webhooks/items/authentication` response property `oneOf` list for the response status `200`
  - for the `query` request parameter `page[size]`, the max was set to `100.00`
  - …2 more
- **2025-06-12** `e93a5ab6e2a5` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/botbrains-io/apis/support-api/changes/api/v2/webhooks/get.md)

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)