Skip to main content
PATCH
Update webhook

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

Webhook endpoint ID

Body

application/json

Payload to update a webhook endpoint.

url
string<uri> | null

New URL for the webhook

Required string length: 1 - 2083
documentCategories
string[] | null

Only send webhooks for these document category codes. Empty list or null = all.

enabled
boolean | null

Enable or disable the webhook

description
string | null

Optional description

Response

Successful Response

Webhook endpoint as returned by the API.

id
string
required

Webhook endpoint ID

url
string
required

URL that receives the webhook payload

enabled
boolean
required

Whether the webhook is active

createdAt
string
required

ISO 8601 creation time

documentCategories
string[] | null

Document categories this webhook is filtered to; null = all

description
string | null

Optional description