Skip to Content
POST
/api/v1/domains/{domain}/event-webhook/test

Queues one webhook.test batch through the real delivery path. The outcome shows on the resource and in the traffic log.

Authorization

bearerAuth
headerAuthorizationBearer <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: [].

Path Parameters

domain*string

Domain name

Response Body

Test batch queued

application/json
  1. response
batchId*string

The queued test batch's id — its outcome shows on the resource and in traffic

Example Request
curl -X POST 'https://api.open.email/api/v1/domains/string/event-webhook/test'
Example Response
{
  "batchId": "string"
}