Change a webhook: url, active, headers, format

PATCH https://api.app2email.com/v1/{number}/webhooks/{id}
scope: webhooks:manage sandbox: real change MCP: update_webhook

Only what is given changes: url, active, headers (a header set to null is removed), format. active: true turns a webhook back on after it was switched off for failures (and clears the failure count). The same url as another webhook of the number: 409 webhook_url_in_use. Needs the 'webhooks:manage' scope.

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
  • id string required

    The webhook's id.

    e.g. wh_a1b2c3d4e5f6g7h8

Body application/json required

  • url string (uri)

    Public https address that accepts POST. No redirects.

    e.g. https://hooks.example.com/app2email-v2
  • events string[] deprecated

    Not used: every webhook gets every event. A PATCH with only events answers 200 with the webhook unchanged.

  • active boolean

    true: turn the webhook on again (after it was switched off for failures). false: turn it off.

  • headers object any keys

    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. A header set to null is removed; "headers": null removes them all.

    e.g. {"Authorization":"Basic dXNlcjpwYXNz"}
  • format string default app2email

    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

200 The webhook.
Fields
  • success boolean
  • request_id string
  • webhook object
    11 fields
    • id string
      e.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.

    • Why it is off, eg after too many failed deliveries in a row, or 'turned off by you'.

    • 3 fields
    • format string default app2email

      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
    • headers object any keys

      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.
  • 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
  • 409 Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published.
  • 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.
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.