Read the domain's event webhook
The domain-scope event webhook: every mailbox whose primary address is on the domain feeds it, plus the domain's directory lifecycle and send outcomes. The signing secret is write-only.
bearerAuthAuthorizationBearer <token>Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.
oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.
oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.
Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].
domain*stringDomain name
The hook
application/json- response
consecutiveFailures*integerConsecutive delivery failures; reset by any success or PUT
createdAt*integerCreation timestamp in epoch seconds
int64degraded?booleanPlatform domains only: true while attempts above the hook's supported rate are queued on their retry ladder (never dropped). The health fields of a platform hook are a projection published at a fixed cadence of about a minute
disabledReason*|'failing' after the 24h auto-disable; any PUT re-enables
domain?stringPresent on the domain scope
enabled*booleanfailingSince*|When the current failing streak began, epoch seconds
int64hasSecret*booleanWhether a signing secret is set (write-only)
lastDeliveredAt*|Last successful delivery, epoch seconds
int64lastFailure*string|nulllastFailureAt*|Last failed delivery, epoch seconds
int64mailboxId?stringPresent on the mailbox scope
retryAfter?|Platform domains only: when the degraded hook has room again, epoch seconds
int64scope*string"mailbox""domain"updatedAt*integerLast update timestamp in epoch seconds
int64url*stringcurl -X GET 'https://api.open.email/api/v1/domains/string/event-webhook'{
"consecutiveFailures": 0,
"createdAt": 0,
"degraded": true,
"disabledReason": "string",
"domain": "string",
"enabled": true,
"failingSince": 0,
"hasSecret": true,
"lastDeliveredAt": 0,
"lastFailure": "string",
"lastFailureAt": 0,
"mailboxId": "string",
"retryAfter": 0,
"scope": "mailbox",
"updatedAt": 0,
"url": "string"
}Create or replace the domain's event webhook PUT
One URL per domain, all events, no filters. Mailboxes on the domain start feeding it within seconds (a background walk arms them) — take a baseline first and…
Remove the domain's event webhook DELETE
Deletes the hook: event batches for the domain's mailboxes stop and nothing is retained. Mailboxes with their OWN hook keep feeding it (the background walk…