Evolution API icon

Evolution API

Interact with Evolution API
Join our community

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 Evolution Bots and their sessions.

Common scenarios include:

  • Automatically adding or configuring new Evolution Bots.
  • Querying existing bots or sessions for monitoring or reporting.
  • Updating bot settings dynamically based on external triggers.
  • Managing session states (open, paused, closed) to control conversation flow.

Practical example:

  • A customer support workflow that creates an Evolution Bot instance when a new product line launches, sets up trigger keywords, and manages session timeouts automatically.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message.
O Que Deseja Fazer Choose the operation to perform with the Evolution Bot integration: Add, Find, Update, 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 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 API. Required for creating or updating a bot.
Tipo De Gatilho Trigger type for the bot: Keyword or All messages.
Operador Do Gatilho Operator for matching the trigger keyword: Contains, Equals, Starts With, Ends With, Regex.
Gatilho The keyword, phrase, or regex pattern used as a trigger to start the Evolution Bot.
Expira Em (Minutos) Number of minutes without responses after which the bot should be 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) Default delay in milliseconds before sending a message.
Palavras Não Reconhecidas Message shown when input is not recognized by the bot. Default is "Mensagem não reconhecida".
Escuta Mensagens Enviadas Por Mim Whether the bot listens to messages sent by the user themselves (boolean).
Pausa O Bot Quando Eu Enviar Uma Mensagem Whether the bot pauses when the user sends a message (boolean).
Mantem a Sessão Do Bot Aberta Whether to keep the bot session open continuously (boolean).
Tempo De Espera (Em Segundos) Time in seconds the bot waits for additional messages after receiving one, then combines them into a single message.
Numero Do Destinatario RemoteJid identifier of the recipient, required when changing session status.
Status Status to set for the session: Opened, Paused, Closed.
JIDs Ignorados List of JIDs (identifiers) that the bot should ignore.

Output

The node outputs JSON data representing the result of the selected operation. This typically includes details about Evolution Bots or 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 URL of the Evolution Bot API endpoint.
  • The node depends on the Evolution Bot service being accessible via the provided API URL.
  • Proper network connectivity and valid credentials are necessary.

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 operation matches the available options.
  • Authentication Failures: Invalid or missing API keys will cause authentication errors. Verify the API key and URL are correct.
  • Missing Required Parameters: Some operations require specific parameters (e.g., bot ID for updates). Omitting these will cause errors.
  • Timeouts or Connectivity Issues: Network problems or incorrect API URLs can lead to request failures.
  • Invalid Trigger Configuration: Using invalid regex or unsupported trigger operators may cause unexpected behavior.

To resolve issues:

  • Double-check all required fields are filled correctly.
  • Confirm API credentials and URLs.
  • Review the chosen operation and its parameter requirements.
  • Test API connectivity outside n8n if needed.

Links and References

  • Evolution Bot official API documentation (not provided here; consult your Evolution Bot provider)
  • n8n documentation on creating custom nodes and using API credentials

Discussion