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 - Create Instance operation, it allows users to create a new WhatsApp instance programmatically. This is useful in scenarios where you want to automate the provisioning of WhatsApp instances for messaging or integration purposes without manual setup.

Practical examples include:

  • Automatically creating new WhatsApp instances when onboarding new clients.
  • Setting up multiple WhatsApp instances for different departments or services.
  • Integrating WhatsApp instance creation into larger automation workflows.

Properties

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

Note: For the Create Instance operation, the node uses the instance name and API key from credentials internally; no other input fields are required.

Output

The output JSON contains the response from the Evolution API after attempting to create the WhatsApp instance. It typically includes details about the newly created instance such as its identifier, status, and any relevant metadata returned by the API.

If an error occurs, the output will contain an error field with the error message.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for the Evolution API, including base URL, API key, and instance name.
  • Optionally uses another API key credential for an auxiliary validation service ("N8N Tools API") to validate subscription and API key before making requests.
  • The node makes HTTP POST requests to the Evolution API endpoints.
  • Proper configuration of these credentials in n8n is necessary for successful execution.

Troubleshooting

  • Invalid Subscription or API Key: If the auxiliary validation fails with 401 or 403 errors, the node throws an error indicating invalid subscription or API key. Verify that the API keys and credentials are correctly configured and active.
  • Unknown Operation or Resource Errors: If an unsupported operation or resource is selected, the node throws an error specifying the unknown operation/resource. Ensure the correct operation "Create Instance" under resource "Instance" is selected.
  • API Request Failures: Network issues or incorrect API endpoint configurations can cause failures. Check network connectivity and verify the base URL and instance name in credentials.
  • Continue On Fail Behavior: If enabled, the node will continue processing subsequent items even if one item fails, returning error details in the output JSON.

Links and References

Discussion