Evolution API Direct icon

Evolution API Direct

Interact with Evolution API using direct URL and API Key

Actions64

Overview

This node allows you to create a new instance in the Evolution API platform. It is designed for users who want to programmatically set up and configure WhatsApp instances with various options such as proxy settings, RabbitMQ event monitoring, webhook configurations, and integration with Chatwoot (a customer engagement platform).

Typical use cases include:

  • Automating the provisioning of WhatsApp instances for messaging or customer support.
  • Integrating WhatsApp communication channels with CRM or helpdesk tools like Chatwoot.
  • Setting up event-driven workflows by enabling RabbitMQ or webhook events.
  • Managing instance behavior such as call rejection, message reading, and group message handling.

For example, a user can create an instance that automatically rejects calls, imports contacts into Chatwoot, and sends webhook notifications on message updates.

Properties

Name Meaning
Server URL The full URL of your Evolution API server (e.g., https://api.exemplo.com).
API Key The API key credential for authenticating with the Evolution API.
Nome Da Instância The name to assign to the new instance being created.
Apikey Para Instancia Optional token specific to the instance for additional authentication.
Número Do WhatsApp Optional phone number to connect to the instance, used to receive pairing codes.
Opções (Options) Collection of optional configuration groups:
- Chatwoot Settings for integrating the instance with Chatwoot, including account ID, admin token, URL, agent signature toggle, message import options, inbox name, contact merging, logo URL, and more.
- Comportamento Instance behavior settings such as rejecting calls, sending messages after call rejection, ignoring group messages, always online status, auto-reading messages, viewing contact statuses, and syncing full message history.
- Proxy Proxy server configuration including host, port, protocol (HTTP/HTTPS), username, and password.
- RabbitMQ RabbitMQ integration settings to enable event monitoring and specify which events to listen for (e.g., CALL, MESSAGES_UPDATE, CONNECTION_UPDATE).
- Webhook Webhook configuration including target URL, whether to create event-specific routes, base64 encoding for media data, and selection of events to receive via webhook.

Output

The node outputs a JSON array containing the response from the Evolution API after creating the instance. This typically includes details about the newly created instance such as its ID, status, configuration, and any relevant metadata returned by the API.

If the instance creation involves binary data (e.g., QR code images for pairing), it would be included in the output accordingly, but this is not explicitly detailed here.

Dependencies

  • Requires access to the Evolution API endpoint specified by the Server URL.
  • Requires a valid API key credential for authentication.
  • Optional dependencies based on configuration:
    • Chatwoot account and admin token if Chatwoot integration is enabled.
    • Proxy server credentials if proxy settings are used.
    • RabbitMQ server if RabbitMQ event monitoring is enabled.
    • A reachable webhook URL if webhook event notifications are configured.

No internal n8n credential names or types are exposed; users must provide their own API keys and tokens.

Troubleshooting

  • Invalid API Key or Server URL: Ensure the API key is correct and the server URL is reachable. Authentication errors will occur otherwise.
  • Missing Required Fields: The instance name and API key are mandatory. Omitting these will cause errors.
  • Proxy Connection Issues: If using a proxy, verify the host, port, protocol, and credentials are correct.
  • Webhook Failures: If webhook URLs are incorrect or unreachable, event delivery will fail.
  • Chatwoot Integration Errors: Incorrect Chatwoot account IDs or tokens will prevent proper integration.
  • Event Subscription Problems: When enabling RabbitMQ or webhook events, ensure the selected events are supported and the respective services are running.

Common error messages will relate to unsupported operations, invalid parameters, or network/authentication failures. Checking logs and verifying all input properties usually resolves these issues.

Links and References

Discussion