Overview
This node integrates with the Evolution API to interact with WhatsApp instances. It allows users to send text messages, send media files, or retrieve a QR code for connecting a WhatsApp instance. This is useful for automating WhatsApp communications such as sending notifications, alerts, marketing messages, or media content directly from workflows.
Practical examples:
- Sending a welcome message to new customers automatically.
- Sharing product images or documents via WhatsApp.
- Retrieving a QR code to link a new WhatsApp instance for further automation.
Properties
| Name | Meaning |
|---|---|
| Instance | The name identifier of the WhatsApp instance to use for the operation. |
| Phone Number | The recipient's phone number including country code. |
| Message | The text message content to be sent (only for Send Message operation). |
Output
The node outputs JSON data representing the response from the Evolution API after performing the requested operation. For example:
- When sending a message or media, the output contains confirmation details or status returned by the API.
- When retrieving a QR code, the output includes the QR code data needed to connect the WhatsApp instance.
No binary data output is produced by this node.
Dependencies
- Requires an external Evolution API service accessible via HTTP.
- Needs an API key credential configured in n8n for authentication with the Evolution API.
- The node uses Axios library internally to make HTTP requests.
Troubleshooting
Common issues:
- Invalid or missing API key will cause authentication failures.
- Incorrect instance name or phone number format may result in errors from the API.
- Network connectivity problems can prevent successful API calls.
Error messages:
"The operation \"<operation>\" is not supported!"indicates an unsupported operation was selected.- Errors related to HTTP requests (e.g., 401 Unauthorized, 404 Not Found) usually mean misconfiguration of credentials or wrong parameters.
Resolutions:
- Verify that the API key credential is correctly set up and has necessary permissions.
- Ensure the instance name matches one registered in the Evolution API system.
- Confirm phone numbers include the correct country code and are formatted properly.
- Check network access and firewall settings to allow outbound requests to the Evolution API endpoint.
Links and References
- Evolution API documentation (refer to your provider’s official docs for detailed API usage)
- WhatsApp Business API guidelines for message formatting and media types