Skip to content
KnockDevelopers
Webhooks

Get a webhook

Chat with a Developer
GET
/v1/webhooks/{webhookId}

Returns one webhook.

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.

Path Parameters

webhookId*string

ID of the webhook.

Formatuuid

Response Body

The webhook.

application/json
  1. response

A URL Knock POSTs events to.

id*string

ID of the webhook, sent as the knock-webhook-id header.

Formatuuid
name*|

The label you gave the webhook. Null when it has none.

url*string

The URL Knock POSTs events to.

Formaturi
events*array<>

The event types sent to this webhook.

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"
status*string

Whether Knock sends events to this webhook: active, or paused (Knock sends it nothing until you set it back to active).

Value in"active""paused"
hasSecretToken*boolean

Whether the webhook has a secret token. The token itself is never returned with the webhook: read it with GET /v1/webhooks/{webhookId}/secret-token.

createdAt*string

When the webhook was created.

Formatdate-time
Example Request
curl -X GET 'https://app.knock-ai.com/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'x-api-key: <YOUR_API_KEY>'
Example Response
{  "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"}