Skip to main content
POST

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.

Path Parameters

id
string
required

Unique identifier for the webhook endpoint.

Example:

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

Body

application/json

The input parameters required for updating a webhook endpoint. Include at least one of url or description.

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>

The new URL. Must be a public https URL. Max 2083 characters.

Example:

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

description
string | null

The new description, or null to remove it. Max 255 characters.

Example:

"Webhook listener v2"

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"