API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Webhook Endpoints

AdminUpdated Sep 11, 2026

Webhook Endpoints

Backend API — secret key (Authorization: Bearer sk_…).

7 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.

Method & path

Scope

Idem

Explanation

POST /v1/webhook_endpoints

webhooks:write

Register a webhook endpoint. The secret is revealed once.

GET /v1/webhook_endpoints

webhooks:read

List webhook endpoints. Never re-reveals secrets.

GET /v1/webhook_endpoints/:id/deliveries

webhooks:read

Delivery log for an endpoint.

POST /v1/webhook_endpoints/:id/rotate_secret

webhooks:write

Rotate the endpoint signing secret. The new secret is revealed exactly once; deliveries signed with the old one are rejected immediately.

POST /v1/webhook_endpoints/:id/deliveries/:deliveryId/redeliver

webhooks:write

Manually redeliver a past event as a fresh attempt. 409 if the event has passed its 90-day retention.

POST /v1/webhook_endpoints/:id/test

webhooks:write

Send a synthetic webhook.test event to this endpoint only. Records a real delivery; never fanned out to other endpoints.

DELETE /v1/webhook_endpoints/:id

webhooks:write

Disable a webhook endpoint.

Was this page helpful?