Overview
This node integrates with the Evolution API for WhatsApp, enabling users to interact programmatically with WhatsApp instances. It supports sending text messages, sending media messages, and retrieving QR codes for WhatsApp instances. This node is useful in scenarios such as automating customer support conversations, broadcasting updates with media content, or managing WhatsApp session authentication via QR codes.
Practical examples:
- Automatically send a welcome message to new customers.
- Share promotional images or videos through WhatsApp.
- Retrieve the QR code needed to authenticate or reconnect a WhatsApp instance.
Properties
| Name | Meaning |
|---|---|
| Instance | The name of the WhatsApp instance to target for the operation (required). |
Note: Although the provided input properties only list "Instance," the node internally supports additional parameters depending on the operation selected (e.g., phone number, message text, media type, media URL, caption), but these are not detailed here as per the user-provided input properties.
Output
The node outputs JSON data corresponding to the result of the requested operation:
- For sending messages (text or media), the output contains the API response confirming message delivery status.
- For retrieving QR codes, the output includes the QR code data from the WhatsApp instance.
- In case of errors, the output JSON will contain an
errorfield with the error message.
The output is structured as an array of JSON objects, each representing the result of processing one input item.
No binary data output is produced by this node.
Dependencies
- Requires an external Evolution API service for WhatsApp, accessible via a base URL and authenticated using an API key.
- The node expects credentials containing the API URL and API key to be configured in n8n.
- Uses the Axios HTTP client library to make REST API calls.
Troubleshooting
- Unsupported Operation Error: If an unsupported operation is specified, the node throws an error indicating the operation is not supported. Ensure the operation parameter matches one of the supported operations (
sendMessage,sendMedia,getQrCode). - API Authentication Errors: If the API key or URL is incorrect or missing, requests will fail. Verify that the credentials are correctly set up.
- Network Issues: Failures in connecting to the Evolution API endpoint may occur due to network problems; check connectivity and endpoint availability.
- Invalid Input Data: Missing required parameters like phone number or message text for sending messages will cause errors. Make sure all required inputs are provided.
- The node supports continuing on failure if enabled, allowing partial processing of multiple items.
Links and References
- Evolution API for WhatsApp documentation (not provided in source; refer to your API provider)
- Axios HTTP client: https://axios-http.com/