Evolution API icon

Evolution API

Complete WhatsApp automation with Evolution API
Join our community

Actions48

Overview

This node integrates with the Evolution API to manage WhatsApp instances and perform various WhatsApp-related operations. Specifically, for the Instance resource and the Get QR Code operation, it retrieves the QR code needed to connect a WhatsApp instance to the Evolution API service.

This is useful in scenarios where you want to programmatically manage WhatsApp connections, such as automating the setup of new WhatsApp instances or reconnecting existing ones by scanning the QR code through an automated workflow.

Practical example:
You can use this node to fetch the QR code image or data that your user needs to scan with their WhatsApp mobile app to authorize and connect the WhatsApp instance to your automation system.

Properties

Name Meaning
Additional Fields Optional extra parameters:
• Delay (number): Delay in milliseconds before sending.
• Link Preview (boolean): Enable link preview in messages.
• Quoted Message ID (string): ID of message to quote/reply to.
• Mentions (string): Comma-separated list of numbers to mention.

Note: For the Get QR Code operation on the Instance resource, the node does not require additional input properties beyond the default credentials and instance configuration.

Output

The output JSON contains the response from the Evolution API endpoint that provides the QR code for connecting the WhatsApp instance. This typically includes:

  • The QR code data or URL that can be displayed or processed further.
  • Metadata about the instance connection status.

The exact structure depends on the Evolution API response but generally includes fields representing the QR code image or string to be scanned.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active subscription and valid API keys for the Evolution API service.
  • Needs proper credentials configured in n8n for accessing the Evolution API, including:
    • Base URL of the Evolution API.
    • API key for authentication.
    • Instance name identifier.
  • Optionally uses another API ("N8N Tools API") for validation of subscription and API key before making requests.

Troubleshooting

  • Invalid subscription or API key error:
    If the node throws an error indicating invalid subscription or API key, verify that the API keys and credentials are correctly set up in n8n and have the necessary permissions.

  • Unknown resource or operation errors:
    These occur if the resource or operation names are incorrect or unsupported. Ensure "Instance" is selected as the resource and "Get QR Code" as the operation.

  • Network or request failures:
    Check network connectivity and that the Evolution API base URL is reachable. Also, confirm that the instance name is correct.

  • Empty or missing QR code in response:
    This might indicate the instance is not ready or connected. Try restarting the instance or checking its connection state.

Links and References

Discussion