Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node, named "Evolution API," allows users to interact with the Evolution API service. Specifically, for the resource "Instancia" and operation "Criar Instancia" (Create Instance), it facilitates creating a new instance within the Evolution platform. This is useful in scenarios where you want to programmatically set up WhatsApp instances integrated with various configurations such as Chatwoot integration, proxy settings, RabbitMQ event monitoring, and webhook event handling.

Practical examples include:

  • Automating the creation of WhatsApp instances for customer support.
  • Integrating WhatsApp messaging with Chatwoot for unified customer communication.
  • Setting up proxies or message queues for scalable message processing.
  • Configuring webhooks to receive real-time events from the instance.

Properties

Name Meaning
Nome Da Instância The name to assign to the new instance. (Required)
Apikey Para Instancia Optional API key token for authenticating the instance.
Número Do WhatsApp Optional phone number to connect to the instance, used to receive pairing codes.
Opções Collection of optional configuration groups:
- Chatwoot Settings to integrate with Chatwoot, including account ID, admin token, URL, agent signature toggle, reopening messages, starting conversations as pending, importing contacts/messages, inbox name, merging Brazilian contacts, QR code contact name, and logo URL.
- Comportamento Instance behavior settings such as rejecting calls, sending rejection messages, ignoring group messages, always online status, auto-marking messages as read, reading contact statuses, and syncing full message history.
- Proxy Proxy server configuration including host, port, protocol (HTTP/HTTPS), username, and password.
- RabbitMQ RabbitMQ event monitoring settings: enable/disable, select which events to monitor (e.g., CALL, CHATS_UPDATE, MESSAGES_SET, etc.), and whether to send media data in base64 format.
- Webhook Webhook configuration including URL, option to create event-specific routes, sending media data in base64, and selecting which events to receive via webhook.

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to create the instance. The exact structure depends on the API response but typically includes details about the created instance such as its ID, status, and configuration summary.

If the node supports binary data output (not explicitly shown here), it would likely relate to media or QR code images associated with the instance setup, but this is not detailed in the provided code.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • Optional dependencies based on configuration:
    • Chatwoot account and admin token for Chatwoot integration.
    • Proxy server credentials if proxy usage is enabled.
    • RabbitMQ server for event monitoring.
    • Webhook endpoint URLs to receive real-time events.

Troubleshooting

  • Common Issues:

    • Missing required property "Nome Da Instância" will prevent instance creation.
    • Invalid or missing API token may cause authentication failures.
    • Incorrect proxy settings can block API communication.
    • Misconfigured webhook URLs or disabled event subscriptions may result in no event notifications.
    • Unsupported operations or resources will throw errors indicating the operation is not supported.

  • Error Messages:

    • "Operação não suportada." means the selected operation-resource combination is not implemented; verify correct selection.
    • Authentication errors usually indicate invalid or missing API keys.
    • Network errors may arise from incorrect proxy or network configurations.

Links and References

Discussion