Send this number's webhooks to app2email again
https://api.app2email.com/v1/{number}/webhook-redirect Removes your URL at Meta. From the next webhook on, app2email receives the number's messages again; messages sent to your URL before stay there.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Responses
Fields
- e.g.
true - e.g.
k3x9a - webhook_redirect object
8 fields
-
true: Meta sends this number's webhooks to your URL, not to app2email.
- url string | null
Your URL at Meta. null: none.
- account_url string | null
An alternate URL set for the whole WhatsApp Business Account (used when the number has none). null: none.
-
off: app2email gets and handles the messages as usual. webhook_redirect: Meta sends them to your URL. pass_through: app2email passes them on to your URL (see pass_through).
offwebhook_redirectpass_through -
Where Meta sends the number's messages now.
webhook_redirectaccount_webhookapp2email - set_at string (date-time) | null
When it was set through app2email. null: not known.
- set_by string | null
Who set it through app2email: the API key's name or the dashboard user.
- pass_through object | null
The Pass-Through Webhook. null: none.
9 fields
-
false: switched off after deliveries kept failing (disabled_reason); app2email then handles the messages itself. PUT again to switch it on.
-
Your signing secret: each POST has X-Hub-Signature-256: sha256=<hex HMAC-SHA256(secret, raw body)>, as Meta signs, and X-App2email-Signature.
-
true: app2email also handles the messages (Inbox, e-mail forwarding, auto replies, agents, apps). false: they only go to your URL.
-
It is one of the number's webhooks (GET /v1/{number}/webhooks: pass_through true): deliveries, retries and redeliver work there.
- set_at string (date-time) | null
- set_by string | null
- disabled_reason string | null
- last_delivery object | null
-
-
- meaning string
- warning string
After a PUT: what stops working on app2email.
Errors
- 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.