GET /v1/webhooks — List Webhook Subscriptions

Use GET /v1/webhooks to retrieve every active webhook subscription associated with your Knock2 tenant. This is useful for auditing which endpoints are receiving event payloads, confirming that a newly created subscription is registered, or building subscription management interfaces for your users.

Endpoint

GET https://api.knock2.ai/v1/webhooks

All active subscriptions for the authenticated tenant are returned in a single response.

Required Scope

Your API key must have the webhooks:read scope (or the broader all:read scope) to call this endpoint.

Parameters

string

Read a direct child tenant’s webhook subscriptions instead of your own (multi-tenant partners only). The X-Knock-Tenant header takes precedence if both are supplied. See Reading a Child Tenant’s Data.

string

Same as product_slug above, as a header instead of a query param. Naming a slug that isn’t a direct child of your key returns 404, never 403.

Example Request

curl https://api.knock2.ai/v1/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

A successful request returns 200 OK with a WebhookListResponse body containing an array of subscription objects.

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "url": "https://your-app.example.com/webhooks/knock2",
      "events": ["account.identified"],
      "name": "CRM sync",
      "secret_prefix": "whsec_abc1234567",
      "is_active": true,
      "created_at": "2024-06-01T14:23:00Z",
      "last_success_at": null,
      "last_failure_at": null
    }
  ]
}

array

An array of webhook subscription objects. Returns an empty array if no subscriptions exist.

string

The unique identifier for the webhook subscription.

string

The HTTPS URL registered to receive event payloads for this subscription.

array of strings

The event types this subscription is currently listening for.

string

The human-readable label assigned to this subscription.

string

A truncated preview of the signing secret for this subscription.

Error Responses

Status	Meaning
`401`	Missing or invalid API key.
`403`	Your API key does not have the `webhooks:read` scope.
`422`	Request could not be processed — verify your request is well-formed.
`429`	Rate limit exceeded. Slow down your request rate and retry.

Overview

Accounts

Contacts

Activity & Scores

Filter Sets

Webhooks

Enrichment & Auth

Tenants & Script

GET /v1/webhooks — List Webhook Subscriptions

Endpoint

Required Scope

Parameters

Example Request

Response

Error Responses

​Endpoint

​Required Scope

​Parameters

​Example Request

​Response

​Error Responses

Endpoint

Required Scope

Parameters

Example Request

Response

Error Responses