v44

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-192301780.0 KB

Webhooks

Create webhook endpoint

Creates a webhook endpoint that receives platform events matching the supplied event-type filters. Returns the generated signing secret ONCE — the response is the only time it is shown in plaintext.

post/webhooks/v1/endpoints

Request body

urlstring uri required

HTTPS callback URL that will receive event deliveries

descriptionstring

Human-readable label for this endpoint

eventTypeFiltersstring[] required

Glob patterns of event types to deliver (e.g. "vault.", "ocr.job.completed", "")

Response

Webhook endpoint created successfully