Send a test event to any URL

Webhook tester
POST https://api.app2email.com/v1/{number}/webhooks/test-url
scope: webhooks:manage sandbox: real change MCP: test_webhook_url

One signed POST to any https URL, answered with the exact request sent and your URL's answer. No saved webhook needed. Shares the 30 tests an hour of the number (429 too_many_tests with Retry-After); 60 an hour per target host and per its IP address.

Path

  • number string required pattern ^[0-9]{8,15}$

    Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.

    e.g. 4976659348270

Body application/json required

  • url string (uri) required

    https only. A private address answers result.stage blocked_address.

    e.g. https://hooks.example.com/app2email
  • type string default ping

    ping or a number event type (x-a2e-webhook-events, not the Partner group).

    e.g. message.received
  • data object any keys

    Your own event data, sent in the normal envelope (at most 16 KB in all).

  • raw object any keys

    Sent as the whole body instead of an envelope.

  • secret string max 200 chars

    Signs the test. Leave out for a new random one (answered in sent.secret).

  • format string default app2email

    meta: the events that come from WhatsApp as Meta's own webhook body.

    app2emailmeta
  • headers object any keys

    Up to 5 custom headers, the same rules as a webhook's.

Responses

200 The test was made: see result.ok and result.stage.
Fields
  • success boolean
  • request_id string
  • sent object
    6 fields
    • method string
    • url string
    • headers object any keys

      Every header sent, both signatures included.

    • body string

      The body exactly as sent and signed.

    • secret string
    • true: no secret was given, this one is new.

  • result object
    8 fields
    • ok boolean

      Your URL answered 2xx within 10 seconds.

    • stage string

      response: your URL answered (see status). Otherwise where it failed.

      responsednsconnecttlstimeoutblocked_address
    • status integer
    • ms integer
    • headers object any keys

      A few of the answer's headers (Content-Type, Date, Server, Location, Retry-After ...).

    • body string

      The first 1000 characters of the answer.

    • message string

      What went wrong, in plain words.

Errors

  • 400 The request is malformed (missing or invalid fields, query parameters or times).
  • 401 Missing, invalid, revoked or expired API key.
  • 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
  • 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
  • 413 The request or the media file is too large.
  • 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
  • 500 Unexpected error on app2email's side.
For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.