Send a test event to the mailbox's event webhook
Queues one webhook.test batch through the real delivery path. The outcome shows on the resource (lastDeliveredAt / lastFailureAt) and in the traffic log — deliberately not a synchronous probe.
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: [].
mailboxId*stringMailbox ULID identifier
Test batch queued
application/json- response
batchId*stringThe queued test batch's id — its outcome shows on the resource and in traffic
curl -X POST 'https://api.open.email/api/v1/mailboxes/string/event-webhook/test'{
"batchId": "string"
}Remove the mailbox's event webhook DELETE
Deletes the hook: event batches stop immediately and nothing is retained. Any batch already in flight completes its retry ladder against nothing and is…
Create or replace the mailbox's message webhook PUT
Every message that lands in this mailbox is POSTed here (the incoming-email payload, its signing and retries), however it got there: any of its addresses, a…