Skip to content
KnockDevelopers
Webhooks

List webhooks

Chat with a Developer
GET
/v1/webhooks

Lists your webhooks, oldest first, a page at a time: limit (default 50, at most 100) and offset.

Needs an API key with read access to integrations: the Admin, Editor, Viewer, CRM Admin or AI Manager role (not an Enrichment API key).

Authorization

ApiKeyAuth
headerx-api-key<token>

Your Knock API key. Reading webhooks takes a key with read access to integrations: the Admin, Editor, Viewer, CRM Admin or AI Manager role (not an Enrichment API key). Changing them takes a key with the Admin role.

Query Parameters

event?string

Only the webhooks that receive this event type.

Value in"meeting.booked""meeting.rescheduled""meeting.declined""meeting.cancelled""meeting.completed""meeting.rejected""outreach.linkedin_invite_sent""outreach.linkedin_invite_accepted""member.linkedin_status_changed""enrichment_request.completed"
limit?integer

Page size.

Range1 <= value <= 100
Default50
offset?integer

Number of webhooks to skip.

Range0 <= value
Default0

Response Body

Your webhooks.

application/json
  1. response

A page of your webhooks.

items*array<>

Webhooks, oldest first.

total*integer

Number of webhooks that match the query, across all pages.

limit*integer

Page size of this page.

offset*integer

Number of webhooks skipped before this page.

maxWebhooks*integer

The most webhooks your account can have, paused ones included: an account limit, not the page size (limit). Creating one more answers webhooks.limit-reached with the same number in metadata.limit.

Example Request
curl -X GET 'https://app.knock-ai.com/v1/webhooks' \  -H 'x-api-key: <YOUR_API_KEY>'
Example Response
{  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "url": "http://example.com",      "events": [        "meeting.booked"      ],      "status": "active",      "hasSecretToken": true,      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "limit": 0,  "offset": 0,  "maxWebhooks": 0}