Evolution API Tool icon

Evolution API Tool

Evolution API WhatsApp integration

Actions3

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.

For example, a user can run this node to get the current QR code image data (or URL) for a WhatsApp instance named "MyInstance", then display it in a UI for scanning with the WhatsApp mobile app to establish the connection.

Properties

Name Meaning
Instance The name identifier of the WhatsApp instance for which to get the QR code.

Output

The output is a JSON array containing the response from the Evolution API's QR code endpoint for the specified instance. The exact structure depends on the API but generally includes data representing the QR code (such as an image URL or base64 encoded string).

No binary data output is produced by this operation.

Example output JSON might look like:

[
  {
    "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "status": "pending"
  }
]

Dependencies

  • Requires an active Evolution API account with valid API credentials (API key and base URL).
  • The node expects these credentials to be configured in n8n under a generic API key credential.
  • Network access to the Evolution API endpoints is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect instance names will result in errors or empty responses.
    • Network connectivity problems may prevent reaching the API endpoint.

  • Error messages:

    • "The operation \"getQrCode\" is not supported!" — indicates an unsupported operation was requested; ensure the operation parameter is set correctly.
    • HTTP errors from the API (e.g., 401 Unauthorized, 404 Not Found) usually indicate credential or instance configuration issues.

  • Resolutions:

    • Verify API credentials are correctly set up in n8n.
    • Confirm the instance name matches exactly what is registered in the Evolution API.
    • Check network connectivity and firewall settings.

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 connections)

Discussion