Evolution API Direct icon

Evolution API Direct

Interact with Evolution API using direct URL and API Key
Join our community

Actions64

Overview

The "Evolution API Direct" node allows users to interact directly with the Evolution API by specifying a server URL and API key. It supports various operations related to managing an "Evolution Bot," such as creating, updating, deleting bots, checking their status, managing sessions, and changing session statuses.

This node is beneficial in scenarios where you want to automate chatbot management tasks within your workflows, for example:

  • Automatically creating or updating chatbots based on external triggers.
  • Monitoring active bot sessions and adjusting their states.
  • Integrating chatbot lifecycle management into broader automation pipelines.

Practical examples include:

  • Creating a new Evolution Bot when a new customer support channel is added.
  • Pausing or closing bot sessions after business hours automatically.
  • Fetching all active sessions to analyze user interactions.

Properties

Name Meaning
Server URL The full URL of your Evolution API server (e.g., https://api.exemplo.com).
API Key The API key credential for authenticating with the Evolution API instance or globally.
Nome Da Instancia The name of the instance that will send the message.
O Que Deseja Fazer Operation to perform with the Evolution Bot integration. Options: Add, Verify, Update, Delete Evolution Bot; Search Sessions; Change Session Status.
ID Do Evolution Bot The ID of the Evolution Bot to find, update, delete, or manage sessions. Leave empty to target all bots when searching.
URL Da API Do Evolution Bot The URL of your specific Evolution Bot instance. Required for creating or updating a bot.
ApiKey Da Evolution Bot The API key for your specific Evolution Bot instance. Required for creating or updating a bot.
Tipo De Gatilho Trigger type for the bot: "Palavra Chave" (keyword) or "Todos" (all messages).
Operador Do Gatilho Operator for trigger matching: contains, equals, startsWith, endsWith, regex. Used only if trigger type is keyword.
Gatilho The keyword, phrase, or regex pattern used as a trigger to start the Evolution Bot.
Expira Em (Minutos) Number of minutes without responses before the bot is deactivated.
Palavra Chave De Finalização Keyword or phrase used to close/end the bot session. Default is "#sair".
Delay Padrão Da Mensagem (Em Milésimos) Delay in milliseconds before the bot sends a message.
Palavras Chave De Finalização (unknownMessage) Message shown when input is not recognized by the bot.
Escuta Mensagens Enviadas Por Mim Boolean flag whether the bot listens to messages sent by the user themselves.
Pausa O Bot Quando Eu Enviar Uma Mensagem Boolean flag to pause the bot when the user sends a message.
Mantem a Sessão Do Bot Aberta Boolean flag to keep the bot session open indefinitely.
Tempo De Espera (Em Segundos) Debounce time in seconds: how long the bot waits for additional messages before processing them together.
Numero Do Destinatario RemoteJid (unique identifier) of the recipient. Required when changing session status.
Status Status to set for a session: opened, paused, or closed. Used when changing session status.
JIDs Ignorados List of JIDs (identifiers) that the bot should ignore.
Tipo do Operador Operator type 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 (such as creation, update, deletion, or status change).

The output structure varies depending on the operation but generally includes fields like bot IDs, session lists, status indicators, and any relevant metadata returned by the Evolution API.

No binary data output is indicated.

Dependencies

  • Requires access to the Evolution API endpoint specified by the user.
  • Requires valid API keys for authentication both at the general Evolution API level and for individual Evolution Bots when applicable.
  • No other external dependencies are indicated.

Troubleshooting

  • Common issues:

    • Invalid or missing API URLs or keys will cause authentication failures.
    • Providing incorrect bot IDs when updating, deleting, or fetching sessions may result in errors or empty results.
    • Misconfigured trigger types or operators can lead to unexpected bot behavior or failure to activate.
    • Ignoring required parameters for certain operations (e.g., remoteJid when changing session status) will cause errors.

  • Error messages:

    • "Operação não suportada." — means the requested operation is not supported for the selected resource. Check that the operation and resource names are correct.
    • API authentication errors — verify API keys and URLs.
    • Validation errors for missing required parameters — ensure all required fields are filled according to the operation.

Links and References

Discussion