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 "Instance" and Operation "Create Instance," 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 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 queue systems (RabbitMQ) for scalable message processing.
  • Configuring webhooks to receive real-time event notifications from the instance.

Properties

Name Meaning
Name 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 the pairing code.
Opções Collection of additional configuration options:
- Chatwoot Settings for integrating 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 messages on call rejection, ignoring group messages, always online status, auto-reading messages, reading status visibility, and full history synchronization.
- Proxy Proxy server configuration including host, port, protocol (HTTP/HTTPS), username, and password.
- RabbitMQ RabbitMQ settings to enable/disable, specify events to monitor, and whether to send media data in base64 format.
- Webhook Webhook configuration including URL, option to create routes per event, 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 likely relate to media or QR code images associated with the instance setup, 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 account and admin token for Chatwoot integration.
    • RabbitMQ server if RabbitMQ event monitoring is enabled.
    • A proxy server if proxy settings are configured.
    • A reachable webhook URL for receiving event callbacks.
  • The node uses the base URL https://doc.evolution-api.com/api-reference for API requests.

Troubleshooting

  • Common Issues:

    • Missing required property "Name Da Instância" will prevent instance creation.
    • Invalid or missing API key/token may cause authentication failures.
    • Incorrect proxy settings can block API communication.
    • Misconfigured webhook URLs or disabled webhook events may result in no event notifications.
    • RabbitMQ misconfiguration can lead to missed or failed event processing.

  • Error Messages:

    • "Operação não suportada." indicates that the selected operation is not supported for the chosen resource; ensure "Instance" and "Create Instance" are correctly selected.
    • API errors returned by the Evolution API will be passed through; check the API documentation for error codes and meanings.

  • Resolutions:

    • Verify all required fields are filled.
    • Confirm API credentials are valid and have necessary permissions.
    • Test proxy connectivity independently.
    • Ensure webhook URLs are publicly accessible and correctly formatted.
    • Validate RabbitMQ connection parameters and event subscriptions.

Links and References

Discussion