Add a partner webhook
https://api.app2email.com/v1/partner/webhooks Every event goes to every webhook (filter by type). Signed like a number's webhooks (X-App2email-Signature, X-Hub-Signature-256). At most 5. "format": "meta" is not available here.
Body application/json required
-
Public https address that accepts POST. No redirects.
e.g.https://hooks.example.com/app2email -
Not used: every webhook gets every event. Accepted (and ignored) so older clients keep working.
-
Up to 5 custom headers sent with every event, eg {"Authorization": "Basic dXNlcjpwYXNz"}. Values: printable ASCII, one line. Not allowed: Host, User-Agent, Content-*, X-App2email-*, X-Hub-*, Proxy-*, X-Forwarded-* and connection headers. Answers (also a test's sent_headers) show each value as its last 4 characters.
e.g.{"Authorization":"Basic dXNlcjpwYXNz"} -
The body format, not an event choice: every webhook still gets every event. meta: what comes from WhatsApp is sent as Meta's own webhook body ({object, entry[].changes[]}, as Meta sent it; X-App2email-Event: meta.<field>), one POST per change, instead of its events (message.*, contact.opted_out, contact.changed_number, number.*, template.status_changed, WhatsApp's handovers and marketing_resumed). app2email's own events (broadcast.completed, usage.threshold, approvals, contact changes made in app2email ...) keep the envelope. Signed the same way.
app2emailmeta
Responses
Fields
- success boolean
- request_id string
- webhook object
11 fields
- id stringe.g.
wh_a1b2c3d4e5f6g7h8 - url string
- events string[]
Every event type: every webhook gets every event.
- secret string
Signs every event: X-App2email-Signature and X-Hub-Signature-256. New one from POST .../rotate-secret.
- previous_secret_until string (date-time)
After rotate-secret with keep_old_for_hours: the old secret also signs (a second v1= in X-App2email-Signature) until then.
- created string (date-time)
- active boolean
false: switched off (see disabled_reason). Turn it on with PATCH active: true.
- disabled_reason string
Why it is off, eg after too many failed deliveries in a row, or 'turned off by you'.
- last_delivery object
-
The body format, not an event choice: every webhook still gets every event. meta: what comes from WhatsApp is sent as Meta's own webhook body ({object, entry[].changes[]}, as Meta sent it; X-App2email-Event: meta.<field>), one POST per change, instead of its events (message.*, contact.opted_out, contact.changed_number, number.*, template.status_changed, WhatsApp's handovers and marketing_resumed). app2email's own events (broadcast.completed, usage.threshold, approvals, contact changes made in app2email ...) keep the envelope. Signed the same way.
app2emailmeta -
The custom headers, each value as its last 4 characters.
e.g.{"Authorization":"****YXNz"}
- note string
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.
- 415 The body is not JSON.
- 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.