> ## Documentation Index > Fetch the complete documentation index at: https://docs.tawked.com/llms.txt > Use this file to discover all available pages before exploring further. # Simulate a received email > With a test key (tk_test_) holding `email:send`: sends one `email.received` webhook in test mode (`"mode": "test"` in the envelope) to the endpoints that receive test events, as if a message had reached the application's hosted address (else its first). Nothing is received, stored or charged, so the id is the event's alone: the received e-mail reads answer it 404. A live key answers `403 test_key_required`. Counts against test mode's 1000 a day for an application (Tawked's limit). Takes no body. Guide: [Receiving email](https://docs.tawked.com/email/receiving.md) ## OpenAPI ````yaml https://tawked.com/openapi.json post /v1/email/received/test openapi: 3.1.0 info: title: Tawked API version: 2026-09 summary: >- Tawked Verify: OTP verification for Saudi mobile numbers over SMS, in two calls. Tawked Notifications: WhatsApp template messages from the application's own number. Tawked Email: transactional e-mail from the application's own verified domain. Tawked Chat: the conversation menus a connected app adds beside the conversations of its connection's application, and the auto-attendant it sets up there. The Partner API for platforms that run Tawked Verify for their merchants. description: >- The public API of Tawked, a Saudi messaging platform: Tawked Verify (one-time codes), Tawked Notifications (WhatsApp templates from the application's own number), Tawked Email (transactional e-mail from the application's own domain) and the Partner API. Tawked Verify is an OTP verification API for Saudi numbers. One call sends a one-time code by SMS to a Saudi mobile number, and a second call checks it. SAR 0.09 per SMS code sent, prepaid; a send the network refuses is refunded. Authenticate with a Bearer API key from the dashboard (tk_live_ for production, tk_test_ for the sandbox, tk_partner_ for partners, tk_partner_test_ for the partner sandbox). Partners (tk_partner_) provision a Verify application per merchant under /v1/partner/applications and name it as application on every Verify call. Both /v1/... and /api/v1/... answer identically. Rate limit: 120 requests per minute per key. termsOfService: https://tawked.com/en/terms license: name: Proprietary (Tawked terms of service) url: https://tawked.com/en/terms contact: name: Tawked support email: support@tawked.com url: https://tawked.com/en/contact servers: - url: https://tawked.com description: Production (the sandbox is a tk_test_ key on the same host) - url: https://tawked.com/api description: The same API under /api/v1/..., kept for older integrations security: - bearerKey: [] - headerKey: [] tags: - name: Verify x-group: Verify description: Send and check one-time codes. - name: WhatsApp x-group: Notifications description: >- Tawked Notifications: send approved WhatsApp templates through the number connected to an application. An application in review or approved connects its own number from the dashboard. - name: Email x-group: Email description: >- Tawked Email: send transactional e-mail from an address on a verified domain of the application, to up to 50 recipients a message, in batches or scheduled, and read and list what was sent. Live keys only. - name: Chat x-group: Chat description: >- Tawked Chat: the conversation menus a connected app adds beside the conversations of its connection's application, and reads, changes and removes, with `chat:menus`; and the application's auto-attendant, which a connected app sets up, publishes and switches on or off, with `chat:attendant`. A connected app's key only; a business adds its own menus and builds its auto-attendant in the console. - name: Partner x-group: Partner API description: >- For platforms that run Tawked Verify for their merchants: provision a Verify application per merchant, keep its brand and verify settings current, switch it off and on, and read usage and the code log. Partner keys (tk_partner_) only; every Verify operation then takes `application` with the partner's own id for the application. - name: Webhooks x-group: Webhooks description: >- The events Tawked sends to your endpoint: an application's verification outcomes and message statuses, and a partner account's lifecycle, balance and opt-in verification events. Every delivery is signed the same way and retried the same way. externalDocs: description: Developer docs, with code samples url: https://docs.tawked.com paths: /v1/email/received/test: post: tags: - Email summary: Simulate a received email description: >- With a test key (tk_test_) holding `email:send`: sends one `email.received` webhook in test mode (`"mode": "test"` in the envelope) to the endpoints that receive test events, as if a message had reached the application's hosted address (else its first). Nothing is received, stored or charged, so the id is the event's alone: the received e-mail reads answer it 404. A live key answers `403 test_key_required`. Counts against test mode's 1000 a day for an application (Tawked's limit). Takes no body. operationId: email_received_test responses: '202': description: Announced content: application/json: schema: type: object properties: id: type: string event: type: string mode: type: string deliveries: type: integer data: type: object properties: id: type: string address: type: object properties: id: type: string domain: type: string kind: type: string to: type: array items: type: string from: type: object properties: name: type: string address: type: string subject: type: string spam: type: boolean has_attachments: type: boolean attachments_count: type: integer size: type: integer status: type: string thread: type: - string - 'null' received_at: type: string format: date-time envelope_from: type: string message_id: type: string in_reply_to: type: - string - 'null' authentication: type: object properties: spf: type: string dkim: type: string dmarc: type: string dmarc_policy: type: - string - 'null' parse: type: string attachments: type: array items: type: - string - 'null' examples: announced: summary: Announced value: id: 0199f3c0-6a7b-7c8d-9e0f-1a2b3c4d5e6f event: email.received mode: test deliveries: 1 data: id: 0199f3c0-6a7b-7c8d-9e0f-1a2b3c4d5e6f address: id: 0199f2b0-1a2b-7c3d-8e4f-5a6b7c8d9e0f domain: acme.inbound.tawked.com kind: hosted to: - test@acme.inbound.tawked.com from: name: Sara address: sara@example.com subject: رسالة تجربة spam: false has_attachments: false attachments_count: 0 size: 2048 status: ready thread: null received_at: '2026-10-26T09:12:03+00:00' envelope_from: sara@example.com message_id: in_reply_to: null authentication: spf: pass dkim: pass dmarc: pass dmarc_policy: null parse: ready attachments: [] '400': description: >- `service_required`: Partner key used with no `application` (or `service`) in the request body.; `invalid_json`: The request body is not valid JSON.; `invalid_request`: start: `to` (and `phone`) both missing or blank. check: `id` or `code` missing. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - service_required - invalid_json - invalid_request '401': description: >- `unauthorized`: Missing, unknown, revoked, or mode-mismatched key; or an unknown/suspended partner.; `key_expired`: The key's `expires_at` has passed. Checked right after the key is recognised, before the IP allowlist or scope. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - unauthorized - key_expired '403': description: >- A live key / `email_early_access`: Tawked Email is early access; apply from the console. The account has not been granted access yet: apply from the application's Email area, and Tawked's team answers on WhatsApp, in the console and by e-mail.; `account_not_active`: The application is not approved yet, the account is banned, or a partner disabled this application. All four causes share this one response.; `ip_not_allowed`: The caller's IP does not match the key's `ip_allowlist` (exact IPs and/or CIDR ranges, IPv4 and IPv6).; `insufficient_scope`: The key was not granted this call: a custom key without this product, or with a level below the call, such as a key that checks where the call sends. The response header `WWW-Authenticate` names the scope the call needs. Judged right after the key is recognised, before `account_not_active` and the request's shape. This operation needs `email:send`.; `test_key_required`: A live key on the simulated receive: a live key receives real mail at its addresses. Call it with the application's test key (tk_test_). content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - email_early_access - account_not_active - ip_not_allowed - insufficient_scope - test_key_required examples: a_live_key: summary: A live key value: error: test_key_required message: >- A received e-mail is simulated with a test key (tk_test_); a live key receives real mail at its addresses. headers: WWW-Authenticate: description: >- Sent with `insufficient_scope` only: the scope this operation needs, which the key was not granted. schema: type: string example: Bearer error="insufficient_scope", scope="email:send" '404': description: >- `service_not_found`: Partner key, but `application`/`service` does not match any of that partner's provisioned applications.; `not_found`: No received e-mail of this application has that id: another application's, one you deleted, one past the 30 days, or an attachment of another e-mail. A partner's key, which receives no e-mail, gets it on every received e-mail call. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - service_not_found - not_found '429': description: >- `test_mode_limit_reached`: Test mode sends at most 1000 e-mails a day for an application (Tawked's limit). It starts again at midnight, Riyadh time.; `too_many_requests`: Per-key rate limit exceeded (default 120 requests/minute, fixed 60s window; 1,200 on the e-mail endpoints). Checked before authentication. The `Retry-After` header gives the seconds to the next window. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - test_mode_limit_reached - too_many_requests '500': description: >- `internal_error`: An unhandled server error. Quote the X-Request-Id header if you report it. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - internal_error x-codeSamples: - lang: bash label: cURL source: |- curl -X POST https://tawked.com/v1/email/received/test \ -H "Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxx" - lang: javascript label: Node.js source: >- const res = await fetch("https://tawked.com/v1/email/received/test", { method: "POST", headers: { Authorization: "Bearer tk_live_xxxxxxxxxxxxxxxxxxxx", }, }); const data = await res.json(); - lang: python label: Python source: |- import requests res = requests.post( "https://tawked.com/v1/email/received/test", headers={"Authorization": "Bearer tk_live_xxxxxxxxxxxxxxxxxxxx"}, ) data = res.json() components: schemas: Error: type: object required: - error properties: error: type: string description: A stable machine-readable code; the docs list every one. additionalProperties: true securitySchemes: bearerKey: type: http scheme: bearer description: >- Authorization: Bearer . An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes `verify:check`, `verify:send` (includes `verify:check`), `notifications:read`, `notifications:send` (includes `notifications:read`), `email:read`, `email:send` (includes `email:read`), `email:manage` (includes `email:send`), `webhooks:manage`, `email:inbound`, `notifications:templates` (includes `notifications:read`), `chat:menus`, `chat:attendant`. No key made on the API keys page holds `notifications:templates`, full access included: the three template writes answer such a key 403 `insufficient_scope`. A connected app's key holds it. Nor `chat:menus`: the five conversation menu operations answer such a key 403 `insufficient_scope`, and a connected app's key holds it once the client approved it. Nor `chat:attendant`: the five auto-attendant operations answer such a key 403 `insufficient_scope` too, and a connected app's key holds it once the client approved it. `email:manage` and `webhooks:manage` are held only by a key someone chose them for: a full-access key, old or new, never holds them. `email:inbound`, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 `insufficient_scope` and names the scope it needs in the `WWW-Authenticate` response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret. headerKey: type: apiKey in: header name: x-api-key description: >- The same API key, with the same access, as a header, for clients that cannot set Authorization. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.