Webhooks

Create webhook endpoint

Changed on

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

  • Base URL
    https://api.case.dev
  • URL
    https://api.case.dev/webhooks/v1/endpoints
  • Auth
    HTTP bearer

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. Persist the signing secret securely; it is shown only once.

signingSecretstring required

One-time webhook signing secret.

Changes