Evolution API

Interact with Evolution API

Actions64

Overview

This n8n custom node, Evolution API, provides integration with the Evolution Bot platform. It allows users to manage and interact with Evolution Bots through various operations such as creating, updating, deleting bots, managing sessions, and changing session statuses. This node is particularly useful for automating workflows that require dynamic bot management, session control, or integration with messaging platforms via Evolution Bot.

Practical examples:

Automatically create a new Evolution Bot instance when onboarding a new client.
Update bot triggers or settings based on workflow conditions.
Fetch or change the status of a bot session in response to user actions.
Delete unused bots as part of a cleanup process.

Properties

Below are the input properties relevant to the Integração resource and Evolution Bot operation:

Display Name	Type	Meaning / Description
Nome Da Instancia	string	The name of the instance that will send the message.
O Que Deseja Fazer	options	Select the specific action to perform with the EvolutionBot integration (e.g., add, update, delete, check, etc.).
ID Do Evolution Bot	string	The ID of the Evolution Bot to target; leave empty to fetch all.
URL Da API Do Evolution Bot	string	The API URL of your Evolution Bot. Required for creation and update operations.
ApiKey Da Evolution Bot	string	The API key for authenticating with your Evolution Bot. Required for creation and update operations.
Tipo De Gatilho	options	The trigger type for the bot (keyword or all).
Operador Do Gatilho	options	The operator used for the trigger (contains, equals, startsWith, endsWith, regex).
Gatilho	string	The keyword/phrase or regex used as a trigger to start the EvolutionBot.
Expira Em (Minutos)	number	Minutes of inactivity before the bot is deactivated.
Palavra Chave De Finalização	string	Keyword/phrase used to close the bot.
Delay Padrão Da Mensagem (Em Milésimos)	number	Default delay (in milliseconds) for bot messages.
Palavra Chave De Finalização	string	Phrase used for unrecognized messages.
Escuta Mensagens Enviadas Por Mim	boolean	Whether the bot listens to messages sent by you.
Pausa O Bot Quando Eu Enviar Uma Mensagem	boolean	Whether the bot pauses when you send a message.
Mantem a Sessão Do Bot Aberta	boolean	Whether to keep the bot session open.
Tempo De Espera (Em Segundos)	number	Time (in seconds) the bot waits for additional messages before grouping them.
Numero Do Destinatario	string	The recipient's remoteJid (used for changing session status).
Status	options	The desired status of the session (opened, paused, closed).
JIDs Ignorados	string[]	List of JIDs to be ignored by the bot.
Tipo do Operador	options	Operator type for the trigger (contains, equals, startsWith, endsWith, regex, none).

Note: Some properties only appear for certain sub-operations (e.g., create, update, changeStatus).

Output

The node outputs a JSON array containing the result(s) of the selected Evolution Bot operation. The structure of each output object depends on the specific action performed, but typically includes fields returned by the Evolution API, such as bot details, session information, or confirmation of the requested action.

Example output (for a successful bot creation):

[
  {
    "id": "12345",
    "instanceName": "MinhaInstancia",
    "status": "created",
    "apiUrl": "https://meubot.evolution-api.com",
    // ...other fields depending on the API response
  }
]

If the operation involves fetching multiple items (e.g., listing bots or sessions), the output will be an array of such objects.

Binary Data: This node does not output binary data; all responses are in JSON format.

Dependencies

External Service: Requires access to the Evolution API endpoint.
API Key: You must provide a valid API key for authentication (ApiKey Da Evolution Bot).
n8n Credentials: The node expects an evolutionApi credential to be configured in n8n.
Environment: Ensure network access to the Evolution API URL you specify.

Troubleshooting

Common Issues:

Missing or Invalid API Key: If the API key is missing or incorrect, authentication will fail.
Incorrect API URL: Providing an invalid or unreachable API URL will result in connection errors.
Unsupported Operation: If you select an unsupported combination of resource and operation, the node will throw an error.

Error Messages:

"Operação não suportada."
"A função "{operation}" para o recurso "{resource}" não é suportada!"
Resolution: Check that you have selected a valid operation for the chosen resource.
API Errors: Any errors returned by the Evolution API (such as validation errors, not found, etc.) will be passed through in the output. Review the error message and adjust your input parameters accordingly.