Skip to main content
POST
Create webhook

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload to create a webhook endpoint.

url
string<uri>
required

URL to receive POST requests when a new document is created

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

Only send webhooks for these document category codes. Omit or null = all document types. See /coverage for valid codes.

description
string | null

Optional description for this webhook

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