Evolution API Direct

Interact with Evolution API using direct URL and API Key

Actions64

Overview

The "Evolution API Direct" node enables interaction with the Evolution API by directly specifying the resource and operation to perform, along with necessary parameters such as server URL and API key. Specifically, for the Integração resource and Typebot operation, this node facilitates managing Typebot chatbots through various actions like creating, updating, deleting, starting bots, managing sessions, and changing session statuses.

This node is beneficial in scenarios where you want to automate chatbot lifecycle management or integrate chatbot interactions within your workflows. For example, you can programmatically start a Typebot session when a user sends a specific keyword, update bot configurations dynamically, or fetch active sessions for monitoring purposes.

Properties

Name	Meaning
Server URL	The full URL of your Evolution API server (e.g., https://api.exemplo.com).
API Key	The API key credential for authenticating requests to the Evolution API instance or globally.
Nome Da Instancia	The name of the instance that will send the message.
O Que Deseja Fazer	The action to perform on the Typebot integration. Options: Add Typebot, Verify Typebot, Update Typebot, Delete Typebot, Start Typebot, Search Session in Typebot, Change Session Status in Typebot.
ID Do Typebot	The ID of the Typebot to target. Leave empty to search all (used for find, update, delete, fetch sessions, change status operations).
URL Da API Do Typebot	The URL of your Typebot API (required for create, update, start operations).
Nome Do Typebot	The name of your Typebot flow (required for create, update, start operations).
Tipo De Gatilho	Trigger type for the Typebot: Keyword or All messages (for create, update operations).
Operador Do Gatilho	Trigger operator when using keyword trigger: Contains, Equals, Starts With, Ends With, Regex (for create, update operations).
Gatilho	The keyword/phrase or regex used as a trigger to start the Typebot (required for create, update operations with keyword trigger).
Expira Em (Minutos)	Number of minutes without response after which the bot should be deactivated (required for create, update operations).
Palavra Chave De Finalização	The keyword/phrase used to close the bot session (default "#sair", required for create, update operations).
Delay Padrão Da Mensagem (Em Milésimos)	Default delay in milliseconds before sending a message from the bot (required for create, update operations).
Palavra Chave De Finalização (unknownMessage)	Message shown when the bot does not recognize input (required for create, update operations).
Escuta Mensagens Enviadas Por Mim	Boolean flag whether the bot listens to messages sent by the user themselves (for create, update operations).
Pausa O Bot Quando Eu Enviar Uma Mensagem	Boolean flag whether to pause the bot when the user sends a message (for create, update operations).
Mantem a Sessão Do Bot Aberta	Boolean flag whether to keep the bot session open (for create, update operations).
Tempo De Espera (Em Segundos)	Time in seconds the bot waits for additional messages before combining them into one (debounce time) (required for create, update operations).
Numero Do Destinatario	RemoteJid identifier of the recipient (required for start and change status operations).
Iniciar Seção	Boolean flag to start a new session (for start operation).
Variáveis	Collection of variables (name-value pairs) to send to the Typebot when starting it (for start operation).
Status	Status to set for the session: Opened, Paused, Closed (for change status operation).

Output

The node outputs JSON data representing the result of the requested Typebot operation. This may include details about created or updated Typebots, lists of sessions, confirmation of deletion or status changes, or error information if the operation fails.

No binary data output is indicated.

Dependencies

Requires access to an Evolution API server endpoint.
Requires a valid API key credential for authentication.
The node expects the user to provide correct URLs and identifiers related to the Typebot service.
No additional external dependencies are indicated beyond the Evolution API and Typebot service.

Troubleshooting

Operation Not Supported Error: If an unsupported operation or resource is selected, the node throws an error indicating the function is not supported. Ensure the resource is "integrations-api" and operation is "typebot" with a valid sub-operation.
Authentication Failures: Incorrect or missing API key or server URL will cause authentication errors. Verify credentials and endpoint correctness.
Missing Required Parameters: Many operations require specific parameters (e.g., typebotId for update/delete). Omitting these will likely cause errors.
Invalid Trigger Configuration: When using keyword triggers, ensure the trigger value and operator are correctly set; invalid regex or empty keywords may cause failures.
Session Management Issues: Starting or changing session status requires a valid remoteJid. Providing incorrect recipient IDs will prevent successful session control.

Links and References

Evolution API Documentation (as referenced in the node's base URL)
Typebot official documentation (not provided here, but recommended to consult for detailed API usage)

This summary is based solely on static analysis of the provided source code and property definitions.