Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The "Evolution API" node enables interaction with the Evolution Bot integration through various operations such as creating, finding, updating, deleting bots, managing sessions, and changing session statuses. It is useful for automating chatbot management tasks within workflows, allowing users to programmatically control bot lifecycle and session behavior.

Common scenarios include:

  • Automatically adding or configuring Evolution Bots based on external triggers.
  • Querying existing bots or sessions to monitor status or retrieve information.
  • Updating bot settings dynamically in response to workflow events.
  • Managing session states (open, paused, closed) to control conversation flow.

For example, a user could create a new Evolution Bot instance with specific trigger keywords and expiration times, or pause a bot session when certain conditions are met.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message.
O Que Deseja Fazer Choose an action 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, fetch sessions, or change status. Leave empty to search all.
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. Required for creating or updating a bot.
Tipo De Gatilho Trigger type for the bot: Keyword or All messages. Used when creating or updating a bot.
Operador Do Gatilho Operator for matching the trigger keyword: Contains, Equals, Starts With, Ends With, Regex. Only applicable if trigger type is Keyword.
Gatilho The keyword, 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 responses 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.
Pausa O Bot Quando Eu Enviar Uma Mensagem Boolean indicating whether the bot pauses when the user sends a message.
Mantem a Sessão Do Bot Aberta Boolean indicating 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. Required for create/update.
Numero Do Destinatario RemoteJid identifier of the recipient. Required when changing session status.
Status Status of the session: Opened, Paused, Closed. Used when changing session status.
JIDs Ignorados List of JIDs (identifiers) that the bot should ignore. Can have multiple values. Used in create/update.
Tipo do Operador Operator type for the trigger: Contains, Equals, Starts With, Ends With, Regex, None. Used in create/update.

Output

The node outputs JSON data representing the result of the selected operation. This typically includes details about Evolution Bots or their sessions, such as bot IDs, configuration parameters, session statuses, and other metadata returned from the Evolution API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution Bot API.
  • Needs the base URL of the Evolution Bot API endpoint.
  • The node depends on the Evolution API service being accessible and properly configured.

Troubleshooting

  • Operation Not Supported Error: If an unsupported operation is selected, the node throws an error indicating the function is not supported for the resource. Ensure the correct operation is chosen.
  • Authentication Failures: Missing or invalid API keys will cause authentication errors. Verify the API key and URL are correctly set.
  • Missing Required Parameters: Some operations require mandatory fields like instanceName, apiUrl, or evolutionBotId. Omitting these will cause errors.
  • Invalid Trigger Configuration: Using incompatible trigger types or operators may lead to unexpected behavior. Confirm trigger settings match the expected format.
  • Session Status Changes: When changing session status, ensure the remoteJid and status are valid and correspond to active sessions.

Links and References

Discussion