Evolution API icon

Evolution API

Interact with Evolution API

Actions114

Integration → Typebot

AI-generated

Overview

This node interacts with the Typebot integration within the Evolution API. It allows users to perform various operations related to Typebot instances, such as creating, updating, deleting, starting Typebots, fetching sessions, and changing session statuses. This node is useful for automating and managing chatbot workflows in Typebot, enabling seamless integration with messaging platforms.

Use Case Examples

  1. Create a new Typebot instance with specific triggers and session settings.
  2. Start a Typebot session for a given recipient number with custom variables.
  3. Fetch and monitor active sessions in a Typebot instance.
  4. Update the configuration of an existing Typebot instance, including triggers and messages.

Properties

Name Meaning
Instance Name The name of the Typebot instance that will send the message, required for identification.
What Do You Want To Do The specific Typebot operation to perform, such as create, find, update, delete, start, fetch sessions, or change session status.
Typebot ID The identifier of the Typebot instance to operate on, used for update, find, delete, fetch sessions, and change status operations.
Typebot API URL The URL endpoint for the Typebot API, required for create, update, and start operations.
Typebot Name The name of the flow in Typebot, required for create, update, and start operations.
Trigger Type The type of trigger to start the Typebot, either keyword or all messages.
Trigger Operator The operator to match the trigger keyword, such as contains, equals, starts with, ends with, or regex.
Trigger The word, phrase, or regex pattern used as a trigger to start the Typebot.
Expires In (Minutes) The duration in minutes after which the bot should be deactivated if no responses are received.
Finish Keyword The word or phrase used to close the bot session.
Default Message Delay (In Milliseconds) The delay in milliseconds before the bot sends a message.
Unknown Message The message sent when the bot does not recognize the input.
Listen To Messages Sent By Me Whether the bot listens to messages sent by the user themselves.
Pause The Bot When I Send A Message Whether the bot pauses when the user sends a message.
Keep The Bot Session Open Whether to keep the bot session open continuously.
Wait Time (In Seconds) The debounce time in seconds to wait for additional messages before merging them into one.
Recipient Number The remoteJid (recipient identifier) for starting or changing the status of a Typebot session.
Start Session Whether to start a new session when starting the Typebot.
Variables A collection of variables (name-value pairs) to send to the Typebot when starting a session.
Status The status to set for a Typebot session, such as opened, paused, or closed.

Output

JSON

  • success - Indicates if the operation was successful.
  • data - Contains the response data from the Typebot API, such as details of the Typebot instance or session information.

Dependencies

  • Evolution API service with Typebot integration

Troubleshooting

  • Ensure the Typebot API URL is correct and accessible to avoid connection errors.
  • Verify that the Typebot ID is provided when required for operations like update, delete, or fetch sessions.
  • Check that all required fields for each operation are filled to prevent validation errors.
  • Handle API errors gracefully by inspecting the response message for issues like authentication failure or invalid parameters.

Links

Discussion