Evolution API

Interact with Evolution API

Actions64

Overview

This n8n node allows you to interact with the Evolution API, specifically targeting the "Integração" resource and the "Flowise" operation. It provides a set of actions for managing Flowise bots, such as creating, updating, deleting, fetching sessions, and changing session statuses. This node is useful in scenarios where you need to automate bot management tasks within your workflows, such as provisioning new bots, updating their configurations, or controlling their operational state.

Practical examples:

Automatically create or update Flowise bots based on workflow triggers.
Fetch or manage Flowise bot sessions for reporting or monitoring purposes.
Change the status of a bot session (e.g., open, pause, close) in response to business events.

Properties

Below are the supported input properties for the "Integração" resource and "Flowise" 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 an action to perform with the Flowise integration (add, check, update, delete, fetch session, change status).
ID Do Flowise	string	The ID of the Flowise bot to target; leave empty to target all.
Url Do Flowise	string	The URL of your Flowise instance. Required for creation and update operations.
ApiKey Do Flowise	string	The API key for your Flowise 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 for the trigger (contains, equals, startsWith, endsWith, regex). Only shown if trigger type is keyword.
Gatilho	string	The word/phrase or regex used as a trigger to start the Flowise bot. Required if trigger type is keyword.
Expira Em (Minutos)	number	Minutes of inactivity before the bot is deactivated.
Palavra Chave De Finalização	string	The word/phrase used to close the bot.
Delay Padrão Da Mensagem (Em Milésimos)	number	Default delay for messages in milliseconds.
Palavra Chave De Finalização (unknownMessage)	string	The word/phrase used when the bot does not recognize a message.
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 combining them.
Numero Do Destinatario	string	The recipient's RemoteJid. Required for changing session status.
Status	options	The desired status of the session (opened, paused, closed).

Note: Some properties are only relevant for specific sub-operations (e.g., create, update, change status).

Output

The output of this node is a JSON array containing the result(s) of the selected Flowise operation. The structure of each item in the array depends on the specific action performed, but typically includes information about the bot or session affected, such as IDs, status, configuration details, or confirmation messages.

If the operation involves fetching data (e.g., find, fetch sessions), the output will be an array of objects representing the retrieved entities.
For create, update, or delete actions, the output will usually contain a confirmation object with relevant identifiers and status.

Example output (for a successful operation):

[
  {
    "success": true,
    "message": "Flowise bot created successfully",
    "botId": "12345"
  }
]

If the node can output binary data, it would be summarized as file content or attachments related to the operation, but for these operations, the output is primarily JSON.

Dependencies

External Service: Requires access to the Evolution API and a valid Flowise instance.
API Key: You must provide a valid API key for the Flowise bot when creating or updating bots.
n8n Credentials: The node requires an "evolutionApi" credential to be configured in n8n.

Troubleshooting

Common issues:

Missing or invalid credentials: Ensure the "evolutionApi" credential is correctly set up in n8n.
Unsupported operation: If you select an unsupported combination of resource and operation, you may see an error like:
- Operação não suportada. A função "X" para o recurso "Y" não é suportada!
  - Resolution: Double-check the selected resource and operation; only supported combinations are allowed.
Required fields missing: If required properties (like instance name, API URL, or API key) are not provided, the operation may fail.
Invalid API endpoint or key: Make sure the Flowise API URL and API key are correct and accessible from your n8n instance.