Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node provides integration with Typebot through the Evolution API, enabling users to manage and interact with Typebot instances programmatically. It supports operations such as creating, verifying, updating, deleting, starting Typebots, fetching sessions, and changing session statuses.

Typical use cases include automating chatbot lifecycle management, controlling bot sessions remotely, and integrating Typebot workflows into broader automation pipelines. For example, a user can start a Typebot session when a specific keyword is detected in incoming messages or update the bot's configuration dynamically based on external triggers.

Properties

Name Meaning
Nombre De La Instancia The name of the instance for the Typebot integration.
Qué Desea Hacer Operation to perform with Typebot integration. Options: Añadir Typebot (create), Verificar Typebot (find), Actualizar Typebot (update), Eliminar Typebot (delete), Iniciar Typebot (start), Buscar Sesión (fetch sessions), Cambiar Estado De La Sesión (change status).
ID De Typebot The ID of the Typebot to find, update, delete, fetch sessions, or change status. Leave empty to search all.
URL De La API De Typebot The URL of your Typebot instance API. Required for create, update, and start operations.
Nombre Do Typebot The name of your Typebot flow. Required for create, update, and start operations.
Tipo De Disparador Trigger type for starting the Typebot. Options: Palabra Clave (keyword), Todos (all). Used in create and update operations.
Operador Del Disparador Trigger operator defining how the trigger value matches input. Options: Contiene (contains), Igual A (equals), Comienza Con (startsWith), Termina Con (endsWith), Regex (regex). Used when trigger type is keyword.
Disparador The keyword, phrase, or regex used as a trigger to start the Typebot. Required when trigger type is keyword.
Expira En (Minutos) Number of minutes without response after which the bot will be deactivated.
Palabra Clave De Finalización Keyword or phrase used to close the bot session.
Retraso Predeterminado Del Mensaje (En Milisegundos) Default delay in milliseconds for the bot's message responses.
Mensaje Desconocido Message shown when the bot does not understand the user's input.
Escucha Mensajes Enviadas Por Mim Whether the bot listens to messages sent by the user themselves.
Pausa O Bot Quando Eu Enviar Uma Mensagem Whether the bot pauses when the user sends a message.
Mantem a Sessão Do Bot Aberta Whether to keep the bot session open continuously.
Tempo De Espera (Em Segundos) Time in seconds that the bot waits for additional messages after receiving one, then merges all messages into one.
Número Del Destinatario RemoteJid identifier of the recipient. Required for starting and changing status of Typebot sessions.
Iniciar Sesión Whether to start a new session when starting a Typebot.
Variables Collection of variables to send to Typebot when starting a session. Each variable has a name and value.
Estado Status to set for a Typebot session. Options: Abierta (opened), Pausada (paused), Cerrada (closed). Used when changing session status.

Output

The node outputs JSON data representing the result of the performed operation. This typically includes details about the Typebot instance, session information, or confirmation of actions like creation, update, deletion, or status changes.

If the operation involves fetching sessions or starting bots, the output may contain session metadata and state information.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API base URL and endpoints to be accessible.
  • Proper configuration of the Typebot URL and credentials is necessary.
  • No other external dependencies are indicated.

Troubleshooting

  • Operation Not Supported Error: If an unsupported operation is selected, the node throws an error indicating the function is not supported. Ensure the correct operation and resource combination is chosen.
  • Missing Required Parameters: Operations require certain parameters (e.g., Typebot ID for update/delete, URL and name for create/start). Missing these will cause errors.
  • API Connectivity Issues: Network or authentication failures with the Evolution API will prevent successful execution.
  • Invalid Trigger Configuration: Incorrect trigger types or operators may cause the bot not to start as expected.
  • To resolve issues, verify all required fields are correctly filled, check API credentials, and ensure network connectivity.

Links and References

Discussion