Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

This node, named "Evolution API," allows users to create and manage instances of a WhatsApp integration service via an API. Specifically, the "Criar Instancia" (Create Instance) operation under the "Instancia" resource enables users to set up a new WhatsApp instance with various configuration options.

Typical use cases include:

  • Automating the creation of WhatsApp instances for customer support or marketing.
  • Integrating WhatsApp messaging with CRM systems like Chatwoot.
  • Configuring proxy settings and message handling behaviors programmatically.
  • Setting up event monitoring through RabbitMQ or webhooks for real-time updates.

For example, a user can create a WhatsApp instance linked to their Chatwoot account, configure how calls are handled, and specify webhook URLs to receive message events automatically.

Properties

Name Meaning
Nome Da Instância The name to assign to the new WhatsApp instance. This is a required string input.
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 A collection of optional configurations including:
- Chatwoot Settings to integrate with Chatwoot CRM, such as account ID, admin token, URL, agent signature toggle, message import options, inbox name, contact merging, and logo URL.
- Comportamento Behavior settings for the instance, including options to reject calls, send messages on call rejection, ignore group messages, keep status always online, auto-read messages, read contact statuses, and sync full history.
- Proxy Proxy server settings including host, port, protocol (HTTP/HTTPS), username, and password.
- RabbitMQ RabbitMQ event monitoring settings, enabling/disabling RabbitMQ and selecting which events to monitor (e.g., calls, chats updates, messages updates).
- Webhook Webhook configuration including URL, whether to create event-specific routes, base64 media encoding option, and selection of events to receive via webhook.

Output

The node outputs a JSON array containing the response from the API after creating the instance. The exact structure depends on the API 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 in the provided code), it would be related to media or QR code images for pairing, but this is not detailed here.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • Optionally integrates with external services like Chatwoot (requires Chatwoot account ID and admin token).
  • May require access to a proxy server if configured.
  • For event monitoring, requires RabbitMQ setup or webhook endpoints accessible by the API.
  • n8n environment must have network access to the Evolution API endpoints and any configured webhook URLs.

Troubleshooting

  • Operation Not Supported Error: If the selected operation or resource is not supported, the node throws an error indicating the function is unsupported. Ensure the correct resource and operation names are selected.
  • Authentication Failures: Missing or invalid API keys will cause authentication errors. Verify that the API key/token is correctly entered and has necessary permissions.
  • Webhook or RabbitMQ Misconfiguration: Incorrect URLs or event selections may result in missing event notifications. Double-check webhook URLs and RabbitMQ credentials/settings.
  • Proxy Connection Issues: If using a proxy, ensure the host, port, protocol, and credentials are correct; otherwise, connection failures may occur.
  • Invalid Input Data: Required fields like "Nome Da Instância" must be provided; missing required inputs will prevent instance creation.

Links and References

Discussion