Test a URL for the Webhook Redirect or the Pass-Through Webhook
https://api.app2email.com/v1/{number}/webhook-redirect/test 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
-
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
-
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 -
webhook_redirect: the token your endpoint expects in hub.verify_token.
-
pass_through: the secret to sign with. Left out: a new random one (test.secret).
Responses
Fields
- e.g.
true - e.g.
k3x9a - test object
9 fields
-
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.
-
webhook_redirectpass_through -
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.
-
5 fields
- answer string | null
The start of the body the URL answered (up to 300 characters).
-
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.