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 Crear Instancia, it enables 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 support, 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 communication.
  • Setting up proxies or message queues (RabbitMQ) for scalable message processing.
  • Configuring webhooks to receive real-time event notifications from the instance.

Properties

Name Meaning
Nombre De La Instancia The name to assign to the new instance (required).
APIKey Para Instancia Optional token to authenticate or authorize the instance creation.
Número De WhatsApp Optional phone number that will connect to the instance to receive pairing codes.
Opciones Collection of additional configuration options:
- Chatwoot Settings related to Chatwoot integration, including account ID, admin token, URL, agent signature toggle, reopening messages, conversation status, contact import, inbox name, merging Brazilian contacts, message import, QR code contact name, and logo URL.
- Comportamiento Instance behavior settings such as rejecting calls, sending messages on call rejection, 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 and selecting which events to monitor (e.g., CALL, CHATS_UPDATE, MESSAGES_SET, etc.).
- Webhook Webhook configuration including URL, whether to create routes per event, base64 encoding for multimedia data, and selection of events to monitor 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 codes associated with the instance, but this is not indicated in the provided code or properties.

Dependencies

  • Requires an API key credential to authenticate requests to the Evolution API.
  • Optionally integrates with external services like Chatwoot (requires Chatwoot account ID, admin token, and URL).
  • May require access to a proxy server if configured.
  • RabbitMQ server for event streaming if enabled.
  • Webhook endpoint URLs must be accessible to receive event callbacks.

Troubleshooting

  • Unsupported Operation Error: If the selected operation is not supported for the resource, the node throws an error indicating the function is not supported. Ensure the correct resource and operation names are used.
  • Authentication Failures: Missing or invalid API tokens will cause authentication errors. Verify that the API key/token is correctly provided.
  • Network Issues: Proxy misconfiguration or unreachable webhook URLs can cause failures. Check proxy settings and webhook endpoint availability.
  • Event Configuration Errors: Selecting unsupported or misspelled event names in RabbitMQ or webhook settings may lead to unexpected behavior or no events being received.
  • Call Rejection Message Not Sent: If the "Mensaje Al Rechazar" is set but calls are not rejected properly, verify that "Rechazar Llamadas" is enabled.

Links and References

Discussion