Skip to main content
The Mail API base is https://api.webdock.dev/api/mail/v1. The Mail API reference tab is generated from the same OpenAPI builder as the application, covering messages, batches, domains, keys, webhooks, suppressions, logs and analytics.
The reference documents the implementation contract. Individual connections and production workers have separate enablement gates. The public documentation does not send authenticated requests from an embedded playground.

​
Authorization

Send Authorization: Bearer YOUR_KEY. Use a Webdock Mail key, not a provider key or Console cookie. Sending endpoints accept sending_access; reading or managing other resources requires full_access, within the key’s resource restrictions.

​
Request limits

Use base64 content for attachments; filesystem paths and remote attachment URLs are unsupported. Consult the generated schema for each operation’s fields and response shapes.

​
Idempotency and revisions

Use a stable Idempotency-Key when sending a message or batch. Completed responses replay for 24 hours. Unknown handoffs remain reserved until reconciliation. Do not change the key to bypass an uncertain result. Rescheduling and cancellation require the current message revision in If-Match. A missing revision returns 428; a stale revision returns 409. Read the current message before making another change.

​
Message and recipient state

Acceptance, delivery, bounce and complaint are different events. A batch can have partial outcomes; inspect the batch and individual messages before deciding what to retry. Simulation is marked separately from live sending and is excluded from default analytics unless requested. The currently verified Turbo transport may provide HTML without a separate text alternative when both are supplied. For inline attachments, follow the documented CID convention: a content_id local part is referenced in HTML with the sender domain appended.

​
Contract source

The reference snapshot is exported from the Mail OpenAPI builder. Download the OpenAPI JSON for client tooling. Refresh it whenever the source contract changes; see documentation maintenance.