New Evolution APIInstall

Summary

Manage Typebot chatbots within the Evolution API integration by performing actions such as creating, verifying, updating, deleting, starting, and controlling chatbot sessions.

Inputs

• Instance Name or ID (required) — Select the Evolution API instance to use or provide its ID via an expression.
• O Que Deseja Fazer (required) — Choose the specific Typebot action to perform: add, find, update, delete, start a chatbot, fetch sessions, or change session status.
• ID Do Typebot — Provide the Typebot ID to target a specific bot for find, update, delete, fetch sessions, or status change operations; leave empty to operate on all available bots when applicable.
• URL Da API Do Typebot (required) — Enter the API URL of the Typebot for creation, updating, or starting actions.
• Nome Do Typebot (required) — Specify the name of the Typebot flow for create, update, or start operations.
• Tipo De Gatilho — Define the trigger type ('keyword' or 'all') for creating or updating a Typebot.
• Operador Do Gatilho — Set the trigger operator (e.g., 'contains', 'equals') when the trigger type is 'keyword' during create or update.
• Gatilho — Provide the keyword, phrase, or regex value used as the trigger for starting a Typebot in create or update operations.
• Expira Em (Minutos) — Duration in minutes after which the bot deactivates due to inactivity, used in create or update actions.
• Palavra Chave De Finalização — Keyword or phrase to close the bot, configured during create or update.
• Delay Padrão Da Mensagem (Em Milésimos) — Default delay in milliseconds for bot messages, set in create or update.
• Mensagem Desconhecida — Message sent when an unknown message is received, set during create or update.
• Escuta Mensagens Enviadas Por Mim — Boolean flag to determine if the bot listens to messages sent by the user, applicable in create or update.
• Pausa O Bot Quando Eu Enviar Uma Mensagem — Boolean flag to pause the bot when the user sends a message, used in create or update.
• Mantem a Sessão Do Bot Aberta — Boolean to keep the bot session open after interaction, relevant in create or update.
• Tempo De Espera (Em Segundos) — Time in seconds to wait and debounce messages for aggregation, set during create or update.
• Numero Do Destinatario (required) — RemoteJid of the recipient to start or change status of a Typebot session.
• Iniciar Seção — Boolean to indicate whether to start a session when starting a Typebot.
• Variáveis — Optional variables to send to the Typebot upon starting a session.
• Status — Status ('opened', 'paused', or 'closed') to set the session state when changing session status.

Output shape

a single record

Returns the result of the requested operation as a JSON object. The output varies depending on the specific Typebot operation performed.

Examples

Example 1: Create a new Typebot

Configure the instance, provide Typebot API URL, name, trigger details, and session behavior settings to add a chatbot.

Example 2: Start a Typebot session

Provide instance, recipient remoteJid, Typebot name, API URL, session start flag, and any variables to launch a chatbot session.