Actions64
- Instancia Actions
- Mensagem Actions
- Grupo Actions
- Chat Actions
- Perfil Actions
- Evento Actions
- Integração Actions
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 chatbot activity.
- 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 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 target all bots when searching. |
| 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 requests to your Evolution Bot. Required for creating or updating a bot. |
| Tipo De Gatilho | Trigger type for the bot: "Palavra Chave" (keyword) or "Todos" (all messages). Used when creating or updating a bot. |
| Operador Do Gatilho | Operator for matching the trigger keyword: contains, equals, startsWith, endsWith, 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 operations. |
| Palavra Chave De Finalização | Keyword or phrase used to close/end the bot session. Required for create/update operations. |
| Delay Padrão Da Mensagem (Em Milésimos) | Default delay in milliseconds before sending a message. Required for create/update operations. |
| Palavras Não Reconhecidas | Message shown when input is not recognized by the bot. Required for create/update operations. |
| Escuta Mensagens Enviadas Por Mim | Boolean flag indicating whether the bot listens to messages sent by the user themselves. |
| Pausa O Bot Quando Eu Enviar Uma Mensagem | Boolean flag indicating whether the bot pauses when the user sends a message. |
| Mantem a Sessão Do Bot Aberta | Boolean flag indicating whether to keep the bot session open indefinitely. |
| Tempo De Espera (Em Segundos) | Time in seconds the bot waits for additional messages before processing them together. Required for create/update operations. |
| Numero Do Destinatario | RemoteJid identifier of the recipient. Required when changing session status. |
| Status | Status to set for the session: "Aberta" (opened), "Pausada" (paused), or "Fechada" (closed). Used when changing session status. |
| JIDs Ignorados | List of JIDs (identifiers) that the bot should ignore. Can have multiple values. Used when creating or updating a bot. |
| Tipo do Operador | Operator type for the trigger: contains, equals, startsWith, endsWith, regex, none. Used when creating or updating a bot. |
Output
The node outputs JSON data representing the result of the selected operation. This typically includes information about Evolution Bots or their sessions, such as bot IDs, configuration details, session statuses, or lists of sessions.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the Evolution Bot API.
- Requires the URL of the Evolution Bot API endpoint.
- The node depends on the Evolution Bot service being accessible via the provided API URL.
- No other external dependencies are indicated.
Troubleshooting
- Operation Not Supported Error: If an unsupported operation is selected, the node throws an error indicating the operation is not supported for the chosen resource. 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, trigger details, and expiration time. Missing these will cause errors.
- Authentication Failures: Incorrect or missing API keys will prevent successful API calls.
- Invalid Trigger Configuration: Using incompatible trigger types or operators may cause the bot not to respond as expected.
- Session Status Changes: When changing session status, ensure the remoteJid and status fields are correctly set.
To resolve issues:
- Verify all required parameters are provided and valid.
- Confirm API credentials and URLs are correct.
- Check that the chosen operation supports the given parameters.
- Review error messages for specific missing or invalid fields.
Links and References
- Evolution Bot official API documentation (not provided here, but recommended to consult).
- n8n documentation on creating custom nodes and using API credentials.