KIkit
Webhooks

List webhook endpoints

Changed on

Returns a paginated list of the account's webhook endpoints. Filter with status to return only active or disabled endpoints.

<strong>OAuth app scoping:</strong> When authenticating with OAuth, this endpoint returns only webhooks created by your OAuth application. Webhooks created via the Kit UI, API keys, or other OAuth apps are not visible. To access all webhooks on an account, authenticate with an API key instead.

Webhook endpoints are the current generation of Kit webhooks: one endpoint subscribes to many event types and receives signed, automatically retried deliveries. They supersede the legacy Webhooks resource — which keeps working — and are the right choice for all new integrations. Start with the webhooks guides.

get/v4/webhook_endpoints

Request

  • Base URL
    https://api.kit.com
  • URL
    https://api.kit.com/v4/webhook_endpoints
  • Auth
    • API key in header X-Kit-Api-Key
    • or OAuth 2
      Authorization code: https://api.kit.com/v4/oauth/authorize
      Token URL: https://api.kit.com/v4/oauth/token

Query parameters

afterunknown

To fetch next page of results, use ?after=<end_cursor>

beforeunknown

To fetch previous page of results, use ?before=<start_cursor>

include_total_countboolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

per_pageunknown

Number of results per page. Default 500, maximum 1000.

status'active' | 'disabled'

Filter endpoints by status. One of: active, disabled.

Response

Returns a paginated list of webhook endpoints

Changes