Create a webhook endpoint

Required scope: webhooks:write. The key must have access to all clients.

Registers an HTTPS URL to receive events for your whole account. Choose up to 32 event_types from List webhook event types. The URL must resolve to a public internet address.

Chronicle returns 201 once the endpoint exists, with the signing secret (whsec_...) used to verify deliveries. The secret is returned only in this first response: a retry with the same Idempotency-Key returns the endpoint without it, and endpoint lists never include it. If you lose the response, get the secret from the webhook portal under Settings > API in Chronicle rather than creating another endpoint.

If Chronicle cannot confirm the result, it returns 503 with Retry-After; retry with the same Idempotency-Key and body. A request whose outcome is still unconfirmed stays tied to its key even after 24 hours, so keep retrying with the same key rather than starting over.

Events contain identifiers and change metadata, never document content, note text or sensitive identifiers. See the Webhooks section for the event format and signature verification.

POST /api/v2/webhook-subscriptions
Bearer token scope webhooks:write

Headers

· 1
Idempotency-Key string · min length: 1· max length: 128 · pattern required

Unique key for this operation, 1 to 128 visible ASCII characters (for example a UUID). Reuse it only when retrying the same request.

Body

required application/json
url string · uri· max length: 2048 required
description string · max length: 500· default:
event_types array of string · min items: 1· max items: 32 required

values

  • v2.client.created
  • v2.client.updated
  • v2.client.deleted
  • v2.case_unit.created
  • v2.case_unit.updated
  • v2.case_unit.deleted

Responses