Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node integrates with the Evolution API to manage and interact with Typebot instances. It allows users to perform various operations such as creating, updating, deleting, starting Typebots, fetching sessions, and changing session statuses. This node is useful for automating chatbot workflows, managing bot lifecycles, and handling user sessions programmatically.

Practical examples include:

  • Automatically creating a new Typebot instance when launching a new campaign.
  • Starting a Typebot conversation with a specific user based on an event trigger.
  • Fetching active sessions to monitor ongoing conversations.
  • Pausing or closing sessions based on business logic or user actions.

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 search for; leave empty to fetch all. Required for update, find, delete, fetch sessions, and change status operations.
URL Da API Do Typebot The URL of your Typebot API. Required for create, update, and start operations.
Nome Do Typebot The name of your flow in Typebot. Required for create, update, and start operations.
Tipo De Gatilho Trigger type for the Typebot integration. Options: Keyword, All. Used in create and update operations.
Operador Do Gatilho Trigger operator to match keywords. Options: Contains, Equals, Starts With, Ends With, Regex. Used when trigger type is Keyword in create and update operations.
Gatilho The keyword/phrase or regex used as a trigger to start the Typebot. Required when trigger type is Keyword in create and update operations.
Expira Em (Minutos) Number of minutes without responses after which the bot should be deactivated. Required in create and update operations.
Palavra Chave De Finalização The keyword/phrase used to close the bot session. Required in create and update operations.
Delay Padrão Da Mensagem (Em Milésimos) Default delay in milliseconds before sending messages from the bot. Required in create and update operations.
Palavra Chave De Finalização (unknownMessage) Message shown when input is not recognized by the bot. Required in create and update operations.
Escuta Mensagens Enviadas Por Mim Boolean indicating whether the bot listens to messages sent by the user themselves. Used in create and update operations.
Pausa O Bot Quando Eu Enviar Uma Mensagem Boolean indicating whether to pause the bot when the user sends a message. Used in create and update operations.
Mantem a Sessão Do Bot Aberta Boolean indicating whether to keep the bot session open. Used in create and update operations.
Tempo De Espera (Em Segundos) Time in seconds the bot waits for additional messages before combining them into one. Required in create and update operations.
Numero Do Destinatario RemoteJid of the recipient. Required for start and change status operations.
Iniciar Seção Boolean to enable or disable starting a session with Chatwoot integration. Used in start operation.
Variáveis Collection of variables (name and value pairs) to send to the Typebot. Used in start operation.
Status Status of the session. Options: Opened, Paused, Closed. Used in change status operation.

Output

The node outputs JSON data representing the result of the requested operation. This typically includes details about the Typebot instance, session information, or confirmation of the performed action. The exact structure depends on the operation executed but generally contains fields like IDs, status, timestamps, and any relevant metadata returned by the Evolution API.

If binary data is involved (not indicated in the provided properties or code), it would represent files or media related to the Typebot interactions, but this node primarily deals with JSON data.

Dependencies

  • Requires an API key credential to authenticate requests to the Evolution API.
  • Needs proper configuration of the base URL and headers for the Evolution API.
  • The node relies on the Evolution API service being available and accessible.
  • No other external dependencies are indicated.

Troubleshooting

  • Common Issues:

    • Missing required parameters such as instanceName, url, or typebot can cause errors.
    • Providing an invalid typebotId when updating, deleting, or fetching sessions may result in "not found" errors.
    • Incorrect API URL or network issues can lead to connection failures.
    • Using unsupported operations or resource combinations will throw an error indicating the operation is not supported.

  • Error Messages:

    • "Operação não suportada." means the selected operation is not implemented for the chosen resource.
    • API authentication errors usually indicate missing or invalid API credentials.
    • Validation errors occur if required fields are empty or have invalid formats.

  • Resolutions:

    • Ensure all required fields are filled correctly according to the operation.
    • Verify API credentials and endpoint URLs.
    • Check network connectivity and API availability.
    • Use valid Typebot IDs and session identifiers.

Links and References

  • Evolution API Documentation (base URL referenced in the node)
  • Typebot official site and documentation (not provided but recommended for understanding Typebot flows and triggers)

Discussion