WebSocket
Webhooks

Register a webhook

Register a webhook URL for risk event notifications.

Payload is delivered via HTTP POST with:

  • X-ZARQ-Event: event type
  • X-ZARQ-Signature: sha256=<hmac> (if secret provided)
  • X-ZARQ-Delivery: unique delivery ID
  • X-ZARQ-Attempt: attempt number (1, 2, 3)

Retry: 3 attempts with exponential backoff (5s, 25s, 125s). Failed deliveries stored in dead letter queue.

post/v1/webhooks/register

Request

  • Base URL: https://zarq.ai (the document declares no server; this is the origin it was published from)
  • URL: https://zarq.ai/v1/webhooks/register
  • Auth: none declared

Request body

urlstring required

Your endpoint URL (HTTPS recommended)

eventsstring[] required

Event types to subscribe to

secretstring nullable

HMAC-SHA256 signing secret

metadataobject nullable

Arbitrary metadata

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.