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

Webhooks

AdminUpdated Sep 11, 2026

Webhooks

Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.

9 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/webhooks

Endpoints with their failure streak, plus the event catalog and retry schedule.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/webhooks

Create an endpoint. The signing secret is returned once here.

PATCH /v1/dashboard/accounts/:accountId/instances/:instanceId/webhooks/:endpointId

Change the URL, the subscribed events, or re-enable a disabled endpoint.

DELETE /v1/dashboard/accounts/:accountId/instances/:instanceId/webhooks/:endpointId

Delete an endpoint and its delivery history.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/webhooks/:endpointId/reveal

Reveal the signing secret. Owner or admin, and audited before it is returned.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/webhooks/:endpointId/rotate

Mint a new signing secret. Old-secret verifiers start failing immediately.

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/webhooks/:endpointId/deliveries

The delivery log, with the payload sent and the response received.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/webhooks/:endpointId/deliveries/:deliveryId/redeliver

Queue a fresh attempt for an event. A new row; the failed one is kept.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/webhooks/:endpointId/test

Send a synthetic webhook.test event to one endpoint. Records a real delivery; never fanned out.

Was this page helpful?