Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node integrates with the Evolution API to manage event notifications via RabbitMQ messaging. It allows users to enable or disable RabbitMQ integration for a specified instance and select which event types should be sent through RabbitMQ. This is useful in scenarios where you want to automate workflows based on real-time events such as message updates, contact changes, group modifications, or bot status changes.

Practical examples include:

  • Activating RabbitMQ to receive live updates when new messages arrive or are deleted.
  • Disabling RabbitMQ integration temporarily without losing configuration.
  • Checking the current RabbitMQ setup status for an instance.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message.
O Que Deseja Fazer Choose between enabling/disabling RabbitMQ integration ("Definir RabbitMQ") or checking its status ("Verificar RabbitMQ").
Ativar RabbitMQ Boolean flag to enable (true) or disable (false) the RabbitMQ integration (only shown when setting RabbitMQ).
Eventos Select one or more event types to send via RabbitMQ. Options include: CALL, CHATS_DELETE, CHATS_SET, CHATS_UPDATE, CHATS_UPSERT, CONNECTION_UPDATE, CONTACTS_SET, CONTACTS_UPDATE, CONTACTS_UPSERT, GROUP_PARTICIPANTS_UPDATE, GROUP_UPDATE, GROUPS_UPSERT, LABELS_ASSOCIATION, LABELS_EDIT, MESSAGES_DELETE, MESSAGES_SET, MESSAGES_UPDATE, MESSAGES_UPSERT, PRESENCE_UPDATE, QRCODE_UPDATED, SEND_MESSAGE, TYPEBOT_CHANGE_STATUS, TYPEBOT_START.

Output

The node outputs a JSON array containing the result of the requested operation. The structure depends on whether the user chose to set or check RabbitMQ:

  • For setting RabbitMQ, the output typically confirms the success or failure of enabling/disabling RabbitMQ and the configured events.
  • For checking RabbitMQ, the output provides the current status and configuration details of RabbitMQ integration for the specified instance.

No binary data output is indicated.

Dependencies

  • Requires an API key credential to authenticate with the Evolution API.
  • The node communicates with the Evolution API endpoint at https://doc.evolution-api.com/api-reference.
  • Proper network access to the Evolution API service is necessary.
  • RabbitMQ server must be properly configured and accessible if enabling integration.

Troubleshooting

  • Common issues:

    • Incorrect instance name may cause failures in setting or retrieving RabbitMQ configuration.
    • Network connectivity problems can prevent communication with the Evolution API.
    • Insufficient permissions or invalid API credentials will result in authentication errors.
    • Selecting no events when enabling RabbitMQ might lead to unexpected behavior or no messages being sent.
  • Error messages:

    • "Operação não suportada." indicates the selected operation is not supported for the resource; verify the chosen operation matches available options.
    • API errors related to authentication or authorization suggest checking the API key credential.
    • Validation errors may occur if required properties like "Nome Da Instancia" are missing or empty.

Links and References

Discussion