Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The Evolution API node enables interaction with the Evolution Bot integration, allowing users to manage and control Evolution Bots programmatically. It supports operations such as creating, finding, updating, deleting bots, managing sessions, and changing session statuses. This node is useful for automating chatbot lifecycle management and session handling in customer support or conversational AI workflows.

Practical examples include:

  • Automatically creating a new Evolution Bot instance with specific triggers and behaviors.
  • Querying existing bots to retrieve their configurations.
  • Updating bot settings like trigger keywords or session expiration times.
  • Deleting obsolete bots.
  • Fetching active sessions of a bot to monitor conversations.
  • Changing the status of a bot session (e.g., opening, pausing, or closing it).

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message.
O Que Deseja Fazer Operation to perform on the Evolution Bot integration. Options: Add Evolution Bot, Find Evolution Bot, Update Evolution Bot, Delete Evolution Bot, Fetch Sessions, Change Session Status.
ID Do Evolution Bot The ID of the Evolution Bot to find, update, delete, fetch sessions, or change status. Leave empty to find all bots.
URL Da API Do Evolution Bot The URL endpoint of your Evolution Bot API. Required for creating or updating a bot.
ApiKey Da Evolution Bot The API key for authenticating with your Evolution Bot API. Required for creating or updating a bot.
Tipo De Gatilho Trigger type for the bot. Options: Keyword, All. Used when creating or updating a bot.
Operador Do Gatilho Operator for the trigger keyword. Options: Contains, Equals, Starts With, Ends With, Regex. Used only if trigger type is Keyword during create/update.
Gatilho The word, phrase, or regex used as a trigger to start the Evolution Bot. Required if trigger type is Keyword during create/update.
Expira Em (Minutos) Number of minutes without response after which the bot should be deactivated. Required for create/update.
Palavra Chave De Finalização The keyword or phrase used to close the bot session. Required for create/update.
Delay Padrão Da Mensagem (Em Milésimos) Default delay in milliseconds before sending a message. Required for create/update.
Palavra Chave De Finalização (unknownMessage) Message shown when input is not recognized by the bot. Required for create/update.
Escuta Mensagens Enviadas Por Mim Boolean indicating whether the bot listens to messages sent by the user themselves. Used in create/update.
Pausa O Bot Quando Eu Enviar Uma Mensagem Boolean indicating whether the bot pauses when the user sends a message. Used in create/update.
Mantem a Sessão Do Bot Aberta Boolean indicating whether to keep the bot session open. Used in create/update.
Tempo De Espera (Em Segundos) Time in seconds the bot waits for additional messages after receiving one, then combines them into a single message. Required for create/update.
Numero Do Destinatario RemoteJid (identifier) of the recipient. Required when changing session status.
Status Status to set for the session. Options: Opened, Paused, Closed. Used when changing session status.
JIDs Ignorados List of JIDs (identifiers) to be ignored by the bot. Can have multiple values. Used in create/update.

Output

The node outputs JSON data representing the result of the selected operation on the Evolution Bot integration. The structure varies depending on the operation but generally includes details about bots, sessions, or confirmation of actions performed.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating requests to the Evolution Bot API.
  • Requires the base URL of the Evolution Bot API.
  • The node depends on the external Evolution Bot service accessible via HTTP REST API.

Troubleshooting

  • Operation Not Supported Error: If an unsupported operation is selected, the node throws an error indicating the operation is not supported for the resource. Ensure the correct operation is chosen.
  • Missing Required Parameters: Operations like create or update require mandatory fields such as API URL, API key, trigger values, etc. Missing these will cause errors.
  • Authentication Failures: Invalid or missing API keys will prevent successful API calls.
  • Invalid IDs: Providing incorrect Evolution Bot IDs or RemoteJids may result in not found errors.
  • Timeouts or Network Issues: Since the node communicates with an external API, network problems can cause failures.

To resolve issues:

  • Verify all required parameters are correctly filled.
  • Confirm API credentials and URLs are valid.
  • Check network connectivity to the Evolution Bot API endpoint.
  • Use the node's test button to validate sending messages.

Links and References

Discussion