Overview
This node integrates with the Evolution API for WhatsApp to enable sending messages and media through a specified WhatsApp instance. It supports three main operations: sending text messages, sending media messages (images, documents, videos, audio), and retrieving a QR code for the WhatsApp instance.
A common use case is automating WhatsApp communications in workflows, such as sending notifications, alerts, or marketing content directly to users' WhatsApp numbers. For example, a business could automatically send an image brochure or a PDF document to customers after they complete a form on a website.
Properties
| Name | Meaning |
|---|---|
| Instance | The name of the WhatsApp instance to use for sending messages or media. |
| Phone Number | The recipient's phone number including country code (e.g., 5511999999999). |
| Media Type | The type of media to send. Options: Image, Document, Video, Audio. |
| Media URL | The URL pointing to the media file to be sent. |
| Caption | Optional caption text to accompany the media message. |
Output
The node outputs JSON data representing the response from the Evolution API after performing the requested operation. This typically includes confirmation details about the sent message or media.
- For sendMessage and sendMedia operations, the output contains metadata about the message delivery status.
- For getQrCode, the output includes the QR code data needed to link the WhatsApp instance.
- If an error occurs and "Continue On Fail" is enabled, the output will contain an error object with the error message.
No binary data output is produced by this node.
Dependencies
- Requires an active Evolution API for WhatsApp account with valid API credentials (API key and base URL).
- The node expects these credentials to be configured in n8n under a generic API authentication token.
- Uses the Axios HTTP client library internally to make REST API calls.
Troubleshooting
- Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect WhatsApp instance name or phone number format may result in errors from the API.
- Sending media requires a publicly accessible URL; private or inaccessible URLs will fail.
- Error messages:
"The operation \"<operation>\" is not supported!"indicates an unsupported operation was requested.- Network or API errors will return their messages in the output if "Continue On Fail" is enabled.
- To resolve errors, verify credentials, ensure correct input formats, and confirm media URLs are reachable.
Links and References
- Evolution API Documentation (example placeholder, replace with actual)
- WhatsApp Business API Overview
- Axios HTTP Client