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 within their workflows. This node supports operations such as creating, verifying, updating, deleting bots, fetching sessions, and changing session statuses. It is particularly useful for automating chatbot management tasks, monitoring bot sessions, and integrating conversational AI capabilities into business processes.

Practical examples include:

  • Automatically creating a new Evolution Bot instance when onboarding a new client.
  • Verifying existing bots to ensure they are active and correctly configured.
  • Updating bot triggers or messages based on changing requirements.
  • Fetching active sessions to monitor user interactions.
  • Changing the status of bot sessions (e.g., pausing or closing) based on workflow conditions.

Properties

Name Meaning
Nombre De La Instancia The name of the Evolution Bot instance to integrate with.
Qué Desea Hacer Operation to perform with Evolution Bot integration. Options: Añadir Evolution Bot, Verificar Evolution Bot, Actualizar Evolution Bot, Eliminar Evolution Bot, Buscar Sesión En Evolution Bot, Cambiar Estado De La Sesión En Evolution Bot.
ID De Evolution Bot The ID of the Evolution Bot to find, update, delete, fetch sessions, or change status. Leave empty to search all.
URL De La API De Evolution Bot The API URL endpoint of your Evolution Bot instance. Required for creating or updating a bot.
APIKey De Evolution Bot The API key for authenticating requests to your Evolution Bot. Required for creating or updating a bot.
Tipo De Disparador Trigger type for the bot. Options: Palabra Clave (keyword), Todos (all). Used when creating or updating a bot.
Operador Del Disparador Operator for the trigger condition. Options: Contiene (contains), Igual A (equals), Comienza Con (startsWith), Termina Con (endsWith), Regex, Ninguno (none). Used when creating or updating a bot.
Disparador The keyword, phrase, or regex used as the trigger to start the Evolution Bot. Required when trigger type is keyword.
Expira En (Minutos) Number of minutes without response after which the bot will be deactivated. Required when creating or updating a bot.
Palabra Clave De Finalización Keyword or phrase used to close the bot session. Required when creating or updating a bot.
Retraso Predeterminado Del Mensaje (En Milisegundos) Default delay in milliseconds before the bot sends a message. Required when creating or updating a bot.
Mensaje Desconocido Message shown when the bot does not understand the user's input. Required when creating or updating a bot.
Escucha Mensajes Enviadas Por Mim Whether the bot listens to messages sent by the user themselves. Boolean flag used when creating or updating a bot.
Pausa O Bot Quando Eu Enviar Uma Mensagem Whether the bot pauses when the user sends a message. Boolean flag used when creating or updating a bot.
Mantem a Sessão Do Bot Aberta Whether to keep the bot session open continuously. Boolean flag used when creating or updating a bot.
Tempo De Espera (Em Segundos) Time in seconds that the bot waits for additional messages after receiving one, then merges them into a single message. Required when creating or updating a bot.
Número Del Destinatario RemoteJid identifier of the recipient. Required when changing the status of a bot session.
Estado Status of the bot session. Options: Abierta (opened), Pausada (paused), Cerrada (closed). Used when changing session status.
JIDs Ignorados List of JIDs (identifiers) that the bot will ignore. Can have multiple values. Used when creating or updating a bot.

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.

If the operation involves fetching or listing bots or sessions, the output will be an array of objects containing relevant information such as bot IDs, statuses, triggers, and session details.

No binary data output is indicated in the source code or properties.

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 Bot external service accessible via HTTP requests.
  • Proper configuration of credentials and API URLs in n8n is necessary for successful operation.

Troubleshooting

  • Common Issues:

    • Missing or incorrect API URL or API key will cause authentication failures.
    • Providing invalid bot IDs when attempting to find, update, delete, or change session status may result in errors or empty results.
    • Incorrect trigger configurations (e.g., invalid regex) can cause unexpected behavior.
    • Network connectivity issues to the Evolution Bot API endpoint will prevent operations from completing.

  • Error Messages:

    • "Operação não suportada." indicates an unsupported operation was requested; verify the selected operation matches supported options.
    • Authentication errors typically indicate invalid or missing API keys.
    • Validation errors may occur if required parameters are missing or malformed.

  • Resolutions:

    • Double-check API URL and API key correctness.
    • Ensure required fields are filled according to the operation.
    • Validate any regex patterns used for triggers.
    • Confirm network access to the Evolution Bot API endpoint.

Links and References

Discussion