> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# WhatsApp connector

- Connector: `appmixer.whatsapp`
- Version: 2.2.1
- Components: 22 (2 triggers, 20 actions)

Connect Appmixer to the WhatsApp Business Cloud API. Send and receive messages, manage media, and react to inbound events.

- Connector page: <https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1>
- Documentation: <https://docs.appmixer.com/connector-configuration/whatsapp>
- Source code: <https://github.com/clientIO/appmixer-connectors/tree/dev/src/appmixer/whatsapp>
- Download package: <https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/download>

## Authentication

**Type:** OAuth 2

**Scopes:**

- `whatsapp_business_messaging`
- `whatsapp_business_management`

## Triggers (2)

- [Message Status Updated](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.notifications.MessageStatusUpdated.md) (`appmixer.whatsapp.notifications.MessageStatusUpdated`): Triggers when a previously sent outbound message changes status (sent / delivered / read / failed).
- [New Message](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.notifications.NewMessage.md) (`appmixer.whatsapp.notifications.NewMessage`): Triggers when a new inbound WhatsApp message is received (text, media, location, interactive response, reaction, or system event).

## Actions (20)

- [List Business Accounts](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.businessAccounts.ListBusinessAccounts.md) (`appmixer.whatsapp.businessAccounts.ListBusinessAccounts`): List the WhatsApp Business Accounts (WABA) granted to the connected account during authentication. Used internally as a dropdown source for the WhatsApp Business Account ID field on other components, but also useful as a standalone action component.
- [Make API Call](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.core.MakeApiCall.md) (`appmixer.whatsapp.core.MakeApiCall`): Performs an arbitrary authorized API call to the WhatsApp Business Cloud / Meta Graph API. Use this for endpoints not covered by dedicated components.
- [Delete Media](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.media.DeleteMedia.md) (`appmixer.whatsapp.media.DeleteMedia`): Delete a media object by its media ID.
- [Download Media](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.media.DownloadMedia.md) (`appmixer.whatsapp.media.DownloadMedia`): Download a media file by its media ID and store it as an Appmixer file.
- [Get Media URL](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.media.GetMediaURL.md) (`appmixer.whatsapp.media.GetMediaURL`): Retrieve a short-lived download URL for a media object by its media ID.
- [Upload Media](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.media.UploadMedia.md) (`appmixer.whatsapp.media.UploadMedia`): Upload media (image/video/audio/document) to WhatsApp servers. Returns a media ID valid for 24 hours.
- [List Message Templates](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.messages.ListMessageTemplates.md) (`appmixer.whatsapp.messages.ListMessageTemplates`): List all pre-approved WhatsApp message templates available on a WhatsApp Business Account (WABA). Used internally as a dropdown source for the Template Name field on Send Template Message, but also useful as a standalone action component for inventory / status auditing.
- [Send Audio Message](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.messages.SendAudioMessage.md) (`appmixer.whatsapp.messages.SendAudioMessage`): Send an audio message to a WhatsApp user. Provide either a media ID or a public HTTPS link. Can only be sent within 24 hours of the recipient's last message to you. Important: A successful response does NOT guarantee delivery. Use the "Message Status Updated" trigger to track delivery status.
- [Send Document Message](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.messages.SendDocumentMessage.md) (`appmixer.whatsapp.messages.SendDocumentMessage`): Send a document (PDF, DOCX, etc.) to a WhatsApp user. Provide either a media ID or a public HTTPS link. Can only be sent within 24 hours of the recipient's last message to you. Important: A successful response does NOT guarantee delivery. Use the "Message Status Updated" trigger to track delivery status.
- [Send Image Message](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.messages.SendImageMessage.md) (`appmixer.whatsapp.messages.SendImageMessage`): Send an image to a WhatsApp user. Provide either a media ID (uploaded via UploadMedia) or a public HTTPS link. Can only be sent within 24 hours of the recipient's last message to you. Important: A successful response does NOT guarantee delivery. Use the "Message Status Updated" trigger to track delivery status.
- [Send Location Message](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.messages.SendLocationMessage.md) (`appmixer.whatsapp.messages.SendLocationMessage`): Send a location pin to a WhatsApp user. Can only be sent within 24 hours of the recipient's last message to you. Important: A successful response does NOT guarantee delivery. Use the "Message Status Updated" trigger to track delivery status.
- [Send Template Message](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.messages.SendTemplateMessage.md) (`appmixer.whatsapp.messages.SendTemplateMessage`): Send a pre-approved WhatsApp template message to a WhatsApp user. Use this for outbound messages outside the 24-hour customer service window. Important: A successful response does NOT guarantee delivery. Use the "Message Status Updated" trigger to track delivery status.
- [Send Text Message](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.messages.SendTextMessage.md) (`appmixer.whatsapp.messages.SendTextMessage`): Send a text message to a WhatsApp user. Can only be sent within 24 hours of the recipient's last message to you. Important: A successful response does NOT guarantee delivery. Use the "Message Status Updated" trigger to track delivery status.
- [Send Video Message](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.messages.SendVideoMessage.md) (`appmixer.whatsapp.messages.SendVideoMessage`): Send a video to a WhatsApp user. Provide either a media ID or a public HTTPS link. Can only be sent within 24 hours of the recipient's last message to you. Important: A successful response does NOT guarantee delivery. Use the "Message Status Updated" trigger to track delivery status.
- [Deregister Sender Phone Number](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.phoneNumbers.DeregisterPhoneNumber.md) (`appmixer.whatsapp.phoneNumbers.DeregisterPhoneNumber`): Deregister YOUR business sender phone number from the WhatsApp Cloud API. Use when migrating the number away from Cloud API or decommissioning it. Does NOT affect recipients.
- [Ensure Sender Phone Number Registered](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.phoneNumbers.EnsurePhoneNumberRegistered.md) (`appmixer.whatsapp.phoneNumbers.EnsurePhoneNumberRegistered`): Idempotent registration helper for YOUR business sender phone number — checks the number's current Cloud API registration status and only calls Register if it isn't already registered. Safe to run once per onboarding flow without re-checking. Does NOT register recipients.
- [Get Sender Phone Number](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.phoneNumbers.GetPhoneNumber.md) (`appmixer.whatsapp.phoneNumbers.GetPhoneNumber`): Retrieve detailed information about one of YOUR WhatsApp Business Sender phone numbers — display name, verified name, quality rating, throughput tier. Does NOT work with recipient numbers.
- [Get Sender Registration Status](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.phoneNumbers.GetRegistrationStatus.md) (`appmixer.whatsapp.phoneNumbers.GetRegistrationStatus`): Check whether YOUR business sender phone number is registered on the WhatsApp Cloud API. Read-only — no side effects. Use for diagnostics or as a branch condition before sending messages. Returns `registered: true` when platform_type is CLOUD_API.
- [List Sender Phone Numbers](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.phoneNumbers.ListPhoneNumbers.md) (`appmixer.whatsapp.phoneNumbers.ListPhoneNumbers`): List all WhatsApp Business Sender phone numbers attached to a WhatsApp Business Account (WABA). These are YOUR business numbers — the numbers you send FROM. Recipients (end users you send TO) are not listed here; they are identified only by their E.164 phone number.
- [Register Sender Phone Number](https://connectors.appmixer.com/connector/appmixer.whatsapp/2.2.1/component/appmixer.whatsapp.phoneNumbers.RegisterPhoneNumber.md) (`appmixer.whatsapp.phoneNumbers.RegisterPhoneNumber`): Register YOUR business sender phone number with the WhatsApp Cloud API. Required one-time step before this number can send or receive messages. Does NOT register recipients — recipients (end users you message) are identified by E.164 phone number and need no registration.

## Changelog

### 2.2.1

- MakeApiCall: Request Headers and Query Parameters set in the Designer are now sent. They were silently dropped: the key-value field stores its rows as a JSON object string, which the component did not parse.

### 2.2.0

- Added test() (Flow Test Mode) to the NewMessage and MessageStatusUpdated triggers (representative synthetic payload — the WhatsApp Cloud API cannot list past messages/statuses).

### 2.1.1

- New WhatsApp Embedded Signup flow (Backoffice: appmixer:whatsapp.esConfigId + Meta App 'Allowed Domains for the JavaScript SDK'). Auth starts on a plugin-served page running Meta's Embedded Signup via the FB JS SDK — users select or create a WABA and phone number, Zapier-style; the resulting token carries enumerable WABA target_ids. Requires a verified business and advanced access for the whatsapp scopes on the Meta App.
- OAuth simplified to two flows: Embedded Signup (esConfigId) and plain OAuth with explicit whatsapp scopes (+ auth_type=rerequest so stale Business Integration grants are re-prompted). The Login-Configuration redirect flow (configId) was removed — it added setup complexity over plain OAuth without any benefit (same picker, same scopes, no WABA enumeration).
- Auth: WABA discovery hardened — /debug_token failures are logged instead of silently swallowed; auth now always fails when the token carries no whatsapp scope at all (Meta drops scopes silently for stale grants or standard access without an app role). WABA IDs are collected from both whatsapp granular scopes; unrestricted grants ('all current and future WABAs', no target_ids) pass with manual WABA entry, with best-effort enumeration via /me/businesses when business_management happens to be granted.
- New ListBusinessAccounts component (businessAccounts/). Lists the WABAs granted during OAuth (from profileInfo, no extra Graph API scope needed) with best-effort name enrichment.
- WhatsApp Business Account ID is now a required dynamic dropdown (sourced from ListBusinessAccounts) on all components that take it — Send*Message, ListMessageTemplates, ListPhoneNumbers, UploadMedia, NewMessage, MessageStatusUpdated. Manual entry remains possible via variable mode.

### 2.0.0

- (breaking change) MakeApiCall: headers and parameters changed from textarea/JSON string to key-value array inputs per standard #1459 (body remains textarea/JSON to support nested structures) — existing flows that used the old string-typed headers or parameters must be updated.

### 1.1.0

- Send*Message component descriptions clarify the 24-hour messaging window and silent-drop behaviour.
- OAuth now uses Facebook Login for Business with a Meta Login Configuration ID (`appmixer:whatsapp.configId` in Backoffice). Customers see the WABA asset picker instead of a plain consent screen. Falls back to plain OAuth when configId is not set.
- Auth fails explicitly when /debug_token returns granular_scopes but no WhatsApp Business Account is selected — prevents 'connected but useless' accounts.
- New ListMessageTemplates component (messages/). Usable standalone and as the dynamic-source dropdown for SendTemplateMessage's Template Name field — customers now pick APPROVED templates from a typeahead.

### 1.0.0

- Initial WhatsApp Business Cloud API connector.
- Messages: SendTextMessage, SendTemplateMessage, SendImageMessage, SendVideoMessage, SendAudioMessage, SendDocumentMessage, SendLocationMessage.
- Media: UploadMedia, GetMediaURL, DownloadMedia, DeleteMedia.
- Sender phone numbers: RegisterSenderPhoneNumber (Register Sender), DeregisterPhoneNumber, ListPhoneNumbers, GetPhoneNumber, GetRegistrationStatus, EnsurePhoneNumberRegistered — all operate on YOUR business sender numbers, never on recipients.
- Triggers (webhook): NewMessage, MessageStatusUpdated.
- Core: MakeApiCall (per #1459 standard).
