Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.knoxcall.com/llms.txt

Use this file to discover all available pages before exploring further.

Update Webhook

PATCH /v1/webhooks/:id
Updates one or more fields on an existing webhook.

Path Parameters

ParameterTypeDescription
iduuidThe webhook ID

Request Body

All fields are optional. Only provided fields will be updated.
FieldTypeDescription
namestringDisplay name
descriptionstringDescription
urlstringDelivery URL
methodstringHTTP method
event_typesstring[]Subscribed event types
auth_typestringAuthentication type: none, basic, bearer, hmac, header
auth_configobjectAuthentication credentials
request_headersobjectCustom delivery headers
route_filterstring[]Array of route UUIDs to filter events by
include_request_bodybooleanInclude request body
include_response_bodybooleanInclude response body
include_headersbooleanInclude headers
timeout_secondsintegerDelivery timeout
retry_on_failurebooleanRetry on failure
max_retriesintegerMax retry attempts
enabledbooleanEnable or disable
hmac_key_iduuidCrypto Keys transit key for HMAC signing
hmac_formatstringSignature format (legacy, stripe, github, slack, aws-sns, custom)
hmac_header_namestringCustom header name when hmac_format is custom

Response

Returns { "data": { ... }, "meta": { ... } } — the updated webhook fields: id, name, description, url, method, event_types, auth_type, enabled, created_at. The secret_key is never returned after creation.

Errors

StatusTypeDescription
400validation_errorNo valid fields provided
404not_foundWebhook not found