API docs

Webhook subscriptions

Manage where events are delivered. Requires the webhooks feature; mutations need write access. Up to 5 active subscriptions per workspace.

  • GET /v1/webhook-subscriptions — list; signing_secret is masked (whsec_…abcd). Object: id, name, url, events, status (active|paused|failed), signing_secret (masked), consecutive_failures, last_success_at, last_failure_at, created_at.
  • POST /v1/webhook-subscriptions — {name, url (must be https), events[], description?} → 201 with the full signing_secret, shown once. Errors: 422 invalid_url / no_events / invalid_event_type, 409 subscription_limit_reached.
  • PATCH /v1/webhook-subscriptions/{id} — {url?, events?, status?}; status may only be active or paused.
  • DELETE /v1/webhook-subscriptions/{id} — removes the subscription and its delivery history.
  • POST /v1/webhook-subscriptions/{id}/rotate-secret — new secret, shown once; deliveries sign with it immediately.
  • POST /v1/webhook-subscriptions/{id}/test — queues a webhook.test event to this subscription only. 409 subscription_not_active unless Active.

Pause = hold: while paused, no new deliveries are created and queued ones are held; resuming flows them. failed means auto-disabled after repeated delivery failures (see the webhooks guide) — fix your endpoint, then set it back to active.