Overview
This node integrates with the Evolution API to interact with WhatsApp instances. Specifically, the "Get QR Code" operation retrieves a QR code for a specified WhatsApp instance. This QR code is typically used to link or authenticate the WhatsApp instance with the Evolution API service.
Common scenarios where this node is beneficial include:
- Automating the setup process of WhatsApp instances by programmatically obtaining the QR code needed for authentication.
- Integrating WhatsApp messaging capabilities into workflows that require dynamic instance management.
- Monitoring or refreshing the connection status of WhatsApp instances by fetching their current QR codes.
For example, a user can run this node to get the QR code image data (usually as a base64 string or URL) and display it in a dashboard or send it to an operator who will scan it with their WhatsApp app to establish the connection.
Properties
| Name | Meaning |
|---|---|
| Instance | The name of the WhatsApp instance for which to retrieve the QR code |
Output
The output JSON contains the data returned from the Evolution API's QR code endpoint for the specified instance. This typically includes the QR code information necessary to connect or authenticate the WhatsApp instance.
The exact structure depends on the API response but generally includes fields such as:
- The QR code image or data (e.g., base64 encoded string or URL)
- Status or metadata about the instance connection
No binary data output is indicated for this operation.
Dependencies
- Requires an active Evolution API account with valid credentials including:
- Base URL of the Evolution API service
- An API key credential for authentication
- The node uses HTTP requests via Axios to communicate with the Evolution API endpoints.
- Proper configuration of the API credentials in n8n is necessary before using this node.
Troubleshooting
Common issues:
- Invalid or missing API key or base URL will cause authentication failures.
- Incorrect instance name may result in errors or empty QR code responses.
- Network connectivity problems can prevent successful API calls.
Error messages:
"The operation \"getQrCode\" is not supported!"— indicates an unsupported operation was requested; ensure the operation parameter is set correctly.- API errors returned from the Evolution API (e.g., 401 Unauthorized, 404 Not Found) should be checked against the API credentials and instance names.
Resolutions:
- Verify that the API key and URL are correctly configured in the node credentials.
- Confirm the instance name matches exactly what is registered in the Evolution API.
- Check network access and firewall settings to allow outbound requests to the Evolution API.
Links and References
- Evolution API official documentation (for WhatsApp integration and QR code retrieval) — consult the provider’s website or API docs.
- n8n documentation on creating and configuring API credentials.
- Axios HTTP client documentation for understanding request/response handling.