Skip to main content
POST
Create Webhook Endpoint

Authorizations

Authorization
string
header
required

Short-lived access token from the device authorization flow. Expires after 15 minutes. Manages only the environment of the client ID it was issued for.

Body

application/json

The input parameters required for creating a webhook endpoint.

environment
enum<string>
required

The environment the webhook endpoint belongs to. Must match your access token's environment.

Available options:
development,
production
Example:

"development"

url
string<uri>
required

The URL Knot sends webhooks to. Must be a public https URL. Max 2083 characters.

Example:

"https://example.com/webhooks/knot"

description
string

A description of the webhook endpoint. Max 255 characters.

Example:

"Primary webhook listener"

Response

Successful request.

id
string

Unique identifier for the webhook endpoint.

Example:

"0a8f5c6e-3d2b-4e1a-9f7c-8b6d5e4c3a21"

url
string

The URL Knot sends webhooks to.

Example:

"https://example.com/webhooks/knot"

description
string | null

A description of the webhook endpoint, or null if none.

Example:

"Primary webhook listener"

environment
enum<string>

The environment the webhook endpoint belongs to.

Available options:
development,
production
Example:

"development"

created_at
string<date-time>

When the webhook endpoint was created, in ISO 8601 format.

Example:

"2026-10-01T14:32:08Z"