Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node integrates with the Typebot service through the Evolution API, enabling users to manage and interact with Typebot chatbots programmatically. It supports operations such as creating, updating, deleting, starting Typebots, managing sessions, and changing session statuses.

Common scenarios include automating chatbot lifecycle management, triggering chatbots based on keywords or other triggers, monitoring active sessions, and controlling chatbot behavior dynamically within workflows.

Practical examples:

  • Automatically create a new Typebot flow when launching a new campaign.
  • Start a chatbot session for a specific user number with predefined variables.
  • Pause or close chatbot sessions based on external events.
  • Fetch active chatbot sessions to analyze user interactions.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message.
O Que Deseja Fazer Operation to perform with 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 fetch all (used in find, update, delete, fetch sessions, change status operations).
URL Da API Do Typebot The URL of your Typebot API endpoint (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 (used in create, update).
Operador Do Gatilho Trigger operator when using keyword trigger: Contains, Equals, Starts With, Ends With, Regex (used in create, update).
Gatilho The keyword, phrase, or regex used as a trigger to start the Typebot (required for create, update with keyword trigger).
Expira Em (Minutos) Number of minutes without response after which the bot should be deactivated (required for create, update).
Palavra Chave De Finalização Keyword or phrase used to close the bot session (required for create, update).
Delay Padrão Da Mensagem Default delay in milliseconds before sending messages from the bot (required for create, update).
Palavra Chave De Finalização Message shown when an unrecognized input is received (required for create, update).
Escuta Mensagens Enviadas Por Mim Whether the bot listens to messages sent by the user themselves (boolean, create, update).
Pausa O Bot Quando Eu Enviar Uma Mensagem Whether to pause the bot when the user sends a message (boolean, create, update).
Mantem a Sessão Do Bot Aberta Whether to keep the bot session open (boolean, create, update).
Tempo De Espera (Em Segundos) Time in seconds the bot waits for additional messages before processing them together (required for create, update).
Numero Do Destinatario RemoteJid (recipient identifier) to start or change status of a Typebot session (required for start, change status operations).
Iniciar Seção Whether to start a new session when starting the Typebot (boolean, start operation).
Variáveis Collection of variables (name-value pairs) to send to the Typebot when starting it (start operation).
Status Status to set for a session: Opened, Paused, Closed (change status operation).

Output

The node outputs JSON data representing the result of the requested operation. This typically includes details about the Typebot(s), session information, or confirmation of actions performed (e.g., creation, update, deletion).

If applicable, the output JSON structure varies depending on the operation but generally contains fields such as:

  • Typebot identifiers and metadata.
  • Session IDs, statuses, and related data.
  • Confirmation messages or error details.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The user must provide the correct Typebot API URL and relevant parameters.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • Operation Not Supported Error: If an unsupported operation is selected, the node throws an error indicating the function is not supported for the chosen resource. Ensure the operation matches the available options.
  • Missing Required Parameters: Operations require certain parameters (e.g., Typebot ID, URL, recipient number). Missing these will cause errors. Double-check required fields are filled.
  • Invalid API URL or Credentials: Incorrect API URLs or invalid authentication tokens will lead to connection failures. Verify API endpoint correctness and credential validity.
  • Session Management Issues: When changing session status or fetching sessions, ensure the Typebot ID and recipient number are accurate to avoid empty or failed responses.
  • Trigger Configuration Errors: For keyword triggers, ensure the trigger value and operator are correctly set; otherwise, the Typebot may not activate as expected.

Links and References

Discussion