KNknotapi

Update Webhook Endpoint

Changed on

Update a webhook endpoint's URL or description.

post/webhook-endpoints/{id}/update

Request

  • Base URL
    https://api.dashboard.knotapi.com
  • URL
    https://api.dashboard.knotapi.com/webhook-endpoints/{id}/update
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:0a8f5c6e-3d2b-4e1a-9f7c-8b6d5e4c3a21

Unique identifier for the webhook endpoint.

Request body

environment'development' | 'production' required

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

urlstring uri

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

descriptionstring nullable

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

Example request

{
  "environment": "development",
  "url": "https://example.com/webhooks/knot-v2",
  "description": "Webhook listener v2"
}

Response

Successful request.

idstring

Unique identifier for the webhook endpoint.

urlstring

The URL Knot sends webhooks to.

descriptionstring nullable

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

environment'development' | 'production'

The environment the webhook endpoint belongs to.

created_atstring date-time

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

Example response

{
  "id": "0a8f5c6e-3d2b-4e1a-9f7c-8b6d5e4c3a21",
  "url": "https://example.com/webhooks/knot",
  "description": "Primary webhook listener",
  "environment": "development",
  "created_at": "2026-10-01T14:32:08Z"
}

Changes