Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The Evolution API node allows users to interact with the Evolution Bot integration through various operations such as creating, finding, updating, deleting bots, managing sessions, and changing session statuses. This node is useful for automating chatbot management tasks within workflows, enabling seamless control over bot lifecycle and session handling.

Common scenarios include:

  • Automating the creation or update of Evolution Bots with specific triggers and behaviors.
  • Querying existing bots or their sessions to monitor or audit activity.
  • Changing the status of bot sessions (open, paused, closed) based on workflow logic.
  • Deleting bots when no longer needed.

Practical example:

  • A customer support workflow that automatically creates an Evolution Bot configured with keyword triggers to handle FAQs, pauses the bot during off-hours, and closes sessions after inactivity.

Properties

Name Meaning
Instance Name The name of the instance that will send the message.
What Do You Want to Do Choose the operation to perform with the Evolution Bot integration: Add, Find, Update, Delete Evolution Bot; Search Sessions; Change Session Status.
ID Do Evolution Bot The ID of the Evolution Bot to find, update, delete, or fetch sessions for. Leave empty to search all.
URL Da API Do Evolution Bot The URL of your Evolution Bot API endpoint. Required for creating or updating a bot.
ApiKey Da Evolution Bot The API key for authenticating with your Evolution Bot. Required for creating or updating a bot.
Tipo De Gatilho Trigger type for the bot: Keyword or All messages.
Operador Do Gatilho Operator for trigger matching: contains, equals, startsWith, endsWith, regex. Only applicable if trigger type is keyword.
Gatilho The word, phrase, or regex pattern used as a trigger to start the Evolution Bot. Required if trigger type is keyword.
Expira Em (Minutos) Number of minutes without response before the bot is disabled.
Palavra Chave De Finalização The keyword or phrase used to close the bot session.
Delay Padrão Da Mensagem (Em Milésimos) Default delay in milliseconds before sending a message.
Palavra Chave De Finalização (unknownMessage) Message shown when input is not recognized by the bot.
Listen to Messages Sent by Me Whether the bot listens to messages sent by the user themselves.
Pausa O Bot Quando Eu Enviar Uma Mensagem Whether to pause the bot when the user sends a message.
Mantem a Sessão Do Bot Open Whether to keep the bot session open continuously.
Tempo De Espera (Em Segundos) Time in seconds the bot waits for additional messages before combining them into one.
Numero Do Destinatario RemoteJid (recipient identifier) for changing session status. Required for status change operation.
Status Status to set for the session: Opened, Paused, Closed. Used in changing session status.
Ignored JIDs List of JIDs (identifiers) that the bot should ignore.
Tipo do Operador Type of operator for the trigger: contains, equals, startsWith, endsWith, regex, none. Used in create/update operations.

Output

The node outputs JSON data representing the result of the selected operation. This typically includes details about the Evolution Bot(s), session information, or confirmation of actions performed (e.g., creation, update, deletion).

The output structure varies depending on the operation but generally returns an array of objects with relevant fields such as bot IDs, names, statuses, session details, and any error or success messages.

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 endpoint.
  • No other external dependencies are indicated.

Troubleshooting

  • Unsupported Operation Error: If an unsupported operation is selected, the node throws an error indicating the operation is not supported. Ensure the operation name matches one of the supported options.
  • Missing Required Parameters: Operations like create or update require parameters such as API URL, API key, and trigger details. Missing these will cause errors.
  • Authentication Failures: Invalid or missing API keys will prevent successful API calls.
  • Invalid Trigger Configuration: Using incompatible trigger types or operators may cause unexpected behavior.
  • Session Status Changes: Providing incorrect RemoteJid or status values may fail to update session status.

To resolve issues:

  • Verify all required parameters are provided and correctly formatted.
  • Confirm API credentials and URLs are valid and accessible.
  • Check that the chosen operation supports the provided parameters.

Links and References

Discussion