app2email API Pricing

Test a URL for the Webhook Redirect or the Pass-Through Webhook

POST https://api.app2email.com/v1/{number}/webhook-redirect/test
scope: webhooks:manage sandbox: refused MCP: test_webhook_redirect

mode pass_through: app2email POSTs a sample incoming message as Meta's own webhook body, signed with your secret (X-Hub-Signature-256, header X-App2email-Test: true); passed is true on a 2xx answer. mode webhook_redirect (the default): app2email sends your URL the check Meta sends when it is set: a GET with hub.mode=subscribe, hub.verify_token (yours) and hub.challenge (a random number). passed is true when the URL answers HTTP 200 with exactly the hub.challenge value. Nothing is set and nothing is kept; run it before PUT /v1/{number}/webhook-redirect. One GET, no redirects, 10 seconds, public addresses only. Shares the 30 tests an hour of the number with the webhook tests (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 required max 500 chars

    The https URL to test (up to 200 characters for webhook_redirect).

  • mode string

    webhook_redirect (default): Meta's GET check. pass_through: a signed sample message POSTed to the URL.

    webhook_redirectpass_through
  • verify_token string max 200 chars

    webhook_redirect: the token your endpoint expects in hub.verify_token.

  • secret string 16–200 chars

    pass_through: the secret to sign with. Left out: a new random one (test.secret).

Responses

200 Tested (see test.passed).
Fields
  • success boolean required
    e.g. true
  • request_id string required
    e.g. k3x9a
  • test object
    9 fields
    • passed boolean required

      webhook_redirect: the URL answered HTTP 200 with exactly the hub.challenge value, as Meta requires. pass_through: it answered 2xx to the signed sample.

    • mode string required
      webhook_redirectpass_through
    • stage string required

      How far it got: response = the URL answered (see status and answer).

      responsednsconnecttlstimeoutblocked_address
    • status integer | null

      The HTTP status the URL answered. null: no answer.

    • ms integer required
    • sent object required
      5 fields
      • method string required
      • url string required

        The URL called (webhook_redirect: the verify token left out).

      • challenge string

        webhook_redirect: the hub.challenge sent.

      • headers object any keys

        pass_through: the headers sent, signatures included.

      • body string

        pass_through: the sample sent (Meta's own body for an incoming text message).

    • answer string | null

      The start of the body the URL answered (up to 300 characters).

    • message string required

      What happened, in plain words, and what to fix.

    • secret string | null

      pass_through without a secret: the random one the sample was signed with.

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.
  • 422 The request is understood but cannot be sent (template parameters, media, text, recipient, or a WhatsApp rule such as the 24 hour window).
  • 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.
  • 502 WhatsApp (Meta) returned an error or could not be reached.
  • 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.
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.