Skip to main content
POST
Create a webhook subscription

Authorizations

Authorization
string
header
required

Dairo API key, e.g. dairo_test_... or dairo_live_...

Headers

Idempotency-Key
string

Optional idempotency key for safe retries of side-effecting operations.

Maximum string length: 128

Body

application/json
url
string<uri>
required
events
enum<string>[]
required
Minimum array length: 1

A subscribable event type. webhook.ping is NOT valid here — it is a synthetic connectivity-test action delivered by POST /v1/webhooks/{id}/ping, not a subscribable event.

Available options:
message.received,
message.quarantined,
message.sent,
message.delivered,
message.bounced,
message.complained,
budget.tripped,
compliance.erasure.completed,
subprocessor.changed,
object.scanned,
share_link.opened,
letter.status_changed,
domain.verified
label
string

Optional human label for the endpoint. Surfaced read-only and used as the primary match field by prefix-scoped test cleanup.

Response

Success

webhook
object
required
secret
string
required

One-time signing secret. Store immediately.