https://api.app2email.com/v1/{number}/webhooks/test-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
-
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
-
https only. A private address answers result.stage blocked_address.
e.g.https://hooks.example.com/app2email -
ping or a number event type (x-a2e-webhook-events, not the Partner group).
e.g.message.received -
Your own event data, sent in the normal envelope (at most 16 KB in all).
-
Sent as the whole body instead of an envelope.
-
Signs the test. Leave out for a new random one (answered in sent.secret).
-
meta: the events that come from WhatsApp as Meta's own webhook body.
app2emailmeta -
Up to 5 custom headers, the same rules as a webhook's.
Responses
Fields
- success boolean
- request_id string
- sent object
- 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
-
A few of the answer's headers (Content-Type, Date, Server, Location, Retry-After ...).
- body string
The first 1000 characters of the answer.
- body_truncated boolean
- 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.