Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node, named "Evolution API," is designed to interact with the Evolution API service. Specifically, for the Resource "Instancia" and Operation "Criar Instancia," it allows users to create a new instance within the Evolution platform. This can be useful in scenarios where you want to programmatically set up WhatsApp instances with customized settings such as proxy configuration, webhook events, RabbitMQ integration, and Chatwoot CRM integration.

Practical examples include:

  • Automating the creation of WhatsApp instances for customer support.
  • Configuring instances with specific behaviors like rejecting calls or ignoring group messages.
  • Integrating with external services like Chatwoot for enhanced messaging management.
  • Setting up event-driven workflows using webhooks or message queues (RabbitMQ).

Properties

Name Meaning
Nome Da Instância The name to assign to the new instance. (Required)
Apikey Para Instancia Optional API 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 for integrating with Chatwoot CRM, including account ID, admin token, URL, agent signature toggle, reopening conversations, importing contacts/messages, inbox name, merging Brazilian contacts, logo URL, etc.
- Comportamento Instance behavior settings such as rejecting calls, sending messages on call rejection, ignoring groups, 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 integration settings, enabling/disabling, selecting which events to monitor, 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 monitor.

Output

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

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

Dependencies

  • Requires an API key credential for authenticating requests to the Evolution API.
  • External services optionally integrated:
    • Chatwoot CRM (requires Chatwoot account ID, admin token, and URL).
    • RabbitMQ message broker (for event monitoring).
    • Webhook endpoints (user-provided URLs to receive event notifications).
  • Network access to Evolution API endpoint (https://doc.evolution-api.com/api-reference).
  • Optional proxy server configuration if network routing requires it.

Troubleshooting

  • Unsupported Operation Error: If the selected operation is not supported for the resource, the node throws an error indicating the operation is unsupported. Ensure that the correct resource and operation names are selected.
  • 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 endpoints may cause request failures. Check proxy settings and network connectivity.
  • Webhook/RabbitMQ Misconfiguration: Incorrect URLs or event selections might result in missing event notifications. Validate webhook URLs and event lists.
  • Invalid Input Data: Required fields like "Nome Da Instância" must be filled; otherwise, the node may fail or return errors.

Links and References

Discussion