Overview
This node enables sending various types of WhatsApp messages with interactive elements such as buttons, lists, templates, or plain text messages. It is useful for automating customer engagement, marketing campaigns, notifications, or support interactions via WhatsApp Business API.
Common scenarios include:
- Sending quick reply buttons to users for easy interaction.
- Presenting a list of options in a structured format.
- Using pre-approved message templates with dynamic parameters.
- Sending simple text messages without interactivity.
For example, a business can send an order confirmation message with buttons like "Track Order" or "Contact Support," or send a product catalog as a list for customers to browse.
Properties
| Name | Meaning |
|---|---|
| Action | Type of message to send. Options: In-Message Buttons, List Buttons, Template, Message |
| List Title | Title of the list button (required if Action is List Buttons) |
| Message | The main message text to be sent (required for In-Message Buttons, List Buttons, and Message) |
| Sender Phone Number (or ID) | The business account's phone number or ID from which the message will be sent |
| Templates | Select a pre-approved WhatsApp template to send (shown if Action is Template) |
| Recipient Phone Number | The phone number of the message recipient |
| Header Type | Type of header to include in the message. Options: None, Image |
| Header Image URL | URL of the image to use as header (required if Header Type is Image) |
| Max 3 Buttons | Up to three buttons with titles for In-Message Buttons action |
| Button List | Sections containing buttons with title and description for List Buttons action |
| Template Parameter List | Parameters to replace placeholders in the selected template (e.g., {{1}}, {{2}}) |
| Should Use Footer | Whether to add a footer message |
| Footer | Text to display at the bottom of the message (shown if Should Use Footer is true) |
| Should Use Proxy URL | Whether to send the request through a proxy URL instead of directly to WhatsApp servers |
| Proxy URL | The proxy URL to send the message through (shown if Should Use Proxy URL is true) |
Output
The node outputs a JSON object representing the response from the WhatsApp API after sending the message. This includes details about the message status and any metadata returned by the API.
If the message is successfully sent, the output JSON contains the API response confirming delivery or acceptance.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the WhatsApp Business API.
- Uses the Facebook Graph API endpoint
https://graph.facebook.com/v20.0. - Optionally supports sending requests through a user-defined proxy URL.
- Axios library is used internally for HTTP requests.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect phone numbers or sender IDs may result in message delivery errors.
- Exceeding button limits (more than 3 buttons for interactive buttons) will cause validation errors.
- Missing required fields depending on the chosen action (e.g., no list title for list buttons) will cause errors.
- Template parameters not matching placeholders in the template may lead to incomplete messages.
Error messages:
- Errors from the WhatsApp API are logged and rethrown as node errors.
- Typical error messages include authorization failures, invalid parameter formats, or quota exceeded.
- To resolve, verify credentials, ensure all required properties are set correctly, and check WhatsApp Business API usage limits.