Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," allows users to create and manage WhatsApp instances through 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. This is useful for automating WhatsApp account management, integrating WhatsApp messaging into workflows, or managing multiple WhatsApp connections programmatically.

Practical examples include:

  • Automatically creating WhatsApp instances for customer support automation.
  • Configuring WhatsApp instances with custom proxy settings or message handling behaviors.
  • Integrating WhatsApp with CRM systems like Chatwoot by importing contacts and messages.
  • Setting up event monitoring via RabbitMQ or webhooks for real-time updates on WhatsApp activity.

Properties

Name Meaning
Nome Da Instância The name to assign to the new WhatsApp 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 additional configuration options:
- Chatwoot Settings to integrate with Chatwoot CRM, including account ID, admin token, URL, agent signature toggle, message reopening, conversation status, contact import, inbox name, contact merging, message import, import limits, 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-reading messages, 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, enabling/disabling RabbitMQ, selecting which events to monitor (e.g., calls, chats updates, messages updates, presence updates, etc.), and whether to send media data in base64 format.
- Webhook Webhook configuration including webhook URL, option to create event-specific routes, sending media data in base64, and selecting which events to receive via webhook.

Output

The node outputs JSON data representing the result of the instance creation operation. This typically includes details about the newly created WhatsApp instance such as its ID, status, configuration summary, and any relevant tokens or URLs returned by the API.

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

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • May require external services depending on configuration:
    • Chatwoot CRM for contact and message synchronization.
    • RabbitMQ for event streaming and monitoring.
    • A proxy server if configured.
    • Webhook endpoints to receive real-time event notifications.
  • Proper network access to the Evolution API endpoint.
  • n8n environment must have the corresponding API credentials configured.

Troubleshooting

  • Common Issues:

    • Missing required property "Nome Da Instância" will prevent instance creation.
    • Incorrect or missing API key/token may cause authentication failures.
    • Invalid proxy settings can block communication with the API.
    • Misconfigured webhook URLs or disabled event subscriptions may result in no event data being received.
    • If the phone number is incorrect or not properly paired, the instance may fail to activate.
  • Error Messages:

    • "Operação não suportada." indicates that the selected operation is not implemented or recognized; ensure correct Resource and Operation are chosen.
    • Authentication errors due to invalid or missing API keys.
    • Network errors related to proxy misconfiguration or unreachable API endpoints.
  • Resolutions:

    • Verify all required fields are filled correctly.
    • Check API key validity and permissions.
    • Confirm proxy details and credentials.
    • Ensure webhook URLs are accessible and correctly formatted.
    • Use valid phone numbers for pairing and activation.

Links and References


Note: This summary is based solely on static analysis of the provided properties and bundled source code without runtime execution or dynamic imports.

Discussion