Webhooks

Create a webhook

Registers a new webhook endpoint. Chronary will deliver signed POST requests to your URL when subscribed events occur. The signing secret is returned only at creation time — store it securely.

post/v1/webhooks

Request

  • Base URL: https://api.chronary.ai
  • URL: https://api.chronary.ai/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required
eventsstring[] required

Response

Webhook created

idstring required
orgIdstring required
urlstring uri required
eventsstring[] required
activeboolean required
consecutiveFailuresinteger required

Circuit-breaker counter: consecutive terminal delivery failures. Reset to 0 on any successful delivery; the endpoint is auto-deactivated at 20 or after 24h of continuous failure.

firstFailureAtstring date-time nullable required

Timestamp of the first failure in the current failure streak; null when there is no active streak.

createdAtstring date-time required
secretstring required

HMAC-SHA256 signing secret — returned once at creation time only. Store it securely.

Example response

{
  "id": "whk_01H9X4M2P5R8T6V0",
  "orgId": "org_01H9X4M2P5R8T6V0",
  "url": "https://example.com/webhooks/chronary",
  "events": [
    "event.created",
    "event.updated"
  ],
  "active": true,
  "createdAt": "2025-01-15T10:00:00.000Z",
  "secret": "whsec_abc123..."
}

Changes

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