Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node integrates with the Typebot service via the Evolution API, allowing users to manage and interact with Typebot instances 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 remotely. For example, a user can create a new Typebot flow with specific trigger keywords, start it for a particular recipient, or pause an ongoing session.

Properties

Name Meaning
Instance Name The name of the instance that will send the message.
What Do You Want to Do 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 find, update, delete, fetch sessions, or change status. Leave empty to search all (only for certain operations).
URL Da API Do Typebot The URL of your Typebot API endpoint (required for create, update, start operations).
Name 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 and update operations).
Operador Do Gatilho Trigger operator when using keyword trigger: Contains, Equals, Starts With, Ends With, Regex (for create and update operations).
Gatilho The word/phrase or regex used as a trigger to start the Typebot (required if trigger type is keyword).
Expira Em (Minutos) Number of minutes without responses after which the bot should be disabled (required for create and update).
Palavra Chave De Finalização The keyword/phrase used to close the bot (required for create and update).
Delay Padrão Da Mensagem (Em Milésimos) Default delay in milliseconds between messages sent by the bot (required for create and update).
Termination Keyword Phrase used when a message is not recognized (required for create and update).
Listen to Messages Sent by Me Whether the bot listens to messages sent by the instance owner (boolean, for create and update).
Pausa O Bot Quando Eu Enviar Uma Mensagem Whether to pause the bot when the instance owner sends a message (boolean, for create and update).
Mantem a Sessão Do Bot Open Whether to keep the bot session open (boolean, for create and update).
Tempo De Espera (Em Segundos) Time in seconds the bot waits for additional messages before combining them into one (required for create and update).
Numero Do Destinatario RemoteJid of the recipient (required for start and change status operations).
Iniciar Seção Whether to start a session (boolean, for start operation).
Variáveis Variables to send to the Typebot as key-value pairs (for start operation).
Status Status of the session: Opened, Paused, Closed (for change status operation).

Output

The node outputs JSON data representing the result of the requested operation on the Typebot integration. This may include details about created or updated Typebots, session information, status changes, or lists of Typebots or sessions depending on the operation performed.

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

Dependencies

  • Requires an API key credential to authenticate requests to the Evolution API.
  • The node expects the user to provide the correct Typebot API URL and relevant parameters.
  • No additional external dependencies are indicated beyond the Evolution API service.

Troubleshooting

  • Operation Not Supported: If an unsupported operation or resource is selected, the node throws an error indicating the function is not supported. Ensure the operation and resource names match those supported by the node.
  • Missing Required Parameters: Many operations require specific parameters (e.g., instanceName, url, typebot, remoteJid). Omitting these will likely cause errors or failed API calls.
  • Invalid API URL or Credentials: Incorrect API URLs or missing/invalid authentication credentials will prevent successful communication with the Typebot API.
  • Session Management Issues: When changing session statuses or fetching sessions, ensure the correct Typebot ID and remoteJid are provided.
  • Trigger Configuration Errors: For keyword triggers, invalid regex patterns or empty trigger values may cause unexpected behavior.

To resolve issues:

  • Double-check required fields for each operation.
  • Verify API URL and credentials.
  • Review error messages returned by the API for more details.

Links and References

Discussion