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.
- Monitoring or managing multiple WhatsApp instances by fetching their connection QR codes on demand.
- Integrating WhatsApp messaging workflows that require dynamic instance linking.
Example: You want to automate the onboarding of new WhatsApp instances in your system. Using this node's "Get QR Code" operation, you can fetch the QR code image data and display it to users for scanning, enabling quick and seamless connection setup.
Properties
| Name | Meaning |
|---|---|
| Instance | The name identifier of the WhatsApp instance for which to get the QR code |
Output
The output JSON contains the data returned from the Evolution API endpoint that provides the QR code for the specified WhatsApp instance. This typically includes the QR code image or its encoded representation, which can be used to display or process the QR code for authentication purposes.
No binary data output is indicated for this operation; the QR code data is returned as JSON.
Dependencies
- Requires an active Evolution API account with valid credentials (an API key and base URL).
- The node uses HTTP requests to communicate with the Evolution API endpoints.
- Proper configuration of the API credentials within n8n is necessary to authenticate requests.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect instance names 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 correctly set to "getQrCode".- API response errors related to authorization or invalid parameters will be returned from the Evolution API and surfaced by the node.
Resolutions:
- Verify that the API key and base URL are correctly configured in the node credentials.
- Confirm the instance name matches exactly the one 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)
- WhatsApp Business API documentation (for understanding QR code usage in WhatsApp instance linking)