Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

This node provides integration with the Typebot service through an API, allowing users to manage and interact with Typebot chatbots programmatically. It supports operations such as creating, updating, deleting, starting a Typebot, checking its status, fetching sessions, and changing session statuses.

Common scenarios where this node is beneficial include automating chatbot lifecycle management, triggering chatbots based on specific keywords or events, managing active chatbot sessions, and integrating chatbot interactions into broader workflows.

Practical examples:

  • Automatically start a Typebot conversation when a user sends a message containing a specific keyword.
  • Update the configuration of an existing Typebot flow without manual intervention.
  • Fetch active chatbot sessions to analyze user engagement or perform session management.
  • Pause or close chatbot sessions based on external triggers or workflow conditions.

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, Check Typebot, Update Typebot, Delete Typebot, Start Typebot, Fetch Typebot Session, Change Typebot Session Status.
Typebot ID The ID of the Typebot to search for or operate on. Leave blank to search all (used in update, find, delete, fetch sessions, change status operations).
Typebot API URL The base URL of your Typebot API endpoint. Required for create, update, and start operations.
Typebot Name The name of your flow in Typebot. Required for create, update, and start operations.
Trigger Type Defines how the bot is triggered. Options: Keyword, All. Used in create and update operations.
Trigger Operator Defines the matching operator for the trigger keyword. Options: Contains, Equals, Starts With, Ends With, Regex. Used when Trigger Type is Keyword.
Trigger The word, phrase, or regex pattern used as a trigger to start the Typebot. Required when Trigger Type is Keyword.
Expires In (Minutes) Number of minutes without responses after which the bot should be deactivated. Required for create and update operations.
Keyword To Finish The word or phrase used to close the bot session. Default is "#sair". Required for create and update operations.
Default Message Delay Delay in milliseconds before the bot sends a message. Required for create and update operations.
Unknown Message Message sent when the bot does not recognize the input. Required for create and update operations.
Listen To Messages Sent By Me Boolean indicating whether the bot listens to messages sent by the user themselves. Used in create and update operations.
Pause The Bot When I Send A Message Boolean indicating whether the bot pauses when the user sends a message. Used in create and update operations.
Keep The Bot Session Open Boolean indicating whether to keep the bot session open indefinitely. Used in create and update operations.
Wait Time (In Seconds) Time in seconds the bot waits for additional messages before joining them into one. Required for create and update operations.
Recipient Number The remoteJid (recipient identifier) to whom the bot session applies. Required for start and change status operations.
Start Session Boolean to enable or disable integration with Chatwoot when starting a Typebot. Used in start operation.
Variables Collection of variables (name-value pairs) to send to the Typebot when starting it. Used in start operation.
Status Status to set for a Typebot session. Options: Opened, Paused, Closed. Used in change status operation.

Output

The node outputs JSON data representing the response from the Typebot API for the requested operation. This typically includes details about the Typebot instance, session information, or confirmation of actions performed (e.g., creation, update, deletion).

If the operation involves fetching sessions or status, the output contains structured session data including identifiers, statuses, and possibly metadata related to the chatbot interaction.

No binary data output is indicated.

Dependencies

  • Requires access to the Typebot API via a valid Typebot API URL.
  • Requires an API key or authentication token configured externally (not shown in the code but implied by the need to authenticate API requests).
  • No explicit mention of other external services or environment variables, but proper network access and credentials are necessary.

Troubleshooting

  • Operation Not Supported Error: If an unsupported operation is selected, the node throws an error indicating the function is not supported. Ensure the chosen operation matches the available options.
  • Missing Required Parameters: Many properties are required depending on the operation (e.g., Typebot API URL, Typebot Name). Missing these will likely cause errors or failed API calls.
  • Invalid Trigger Configuration: Using incorrect trigger types or operators may result in the Typebot not activating as expected.
  • Session Management Issues: Incorrect recipient numbers or session IDs can cause failures in fetching or changing session statuses.
  • API Connectivity Problems: Network issues or invalid API URLs will prevent successful communication with Typebot.

To resolve these issues:

  • Double-check all required parameters are provided and correctly formatted.
  • Verify API URL and credentials are correct and accessible.
  • Confirm the Typebot ID and recipient identifiers are valid.
  • Review the trigger settings to ensure they match the intended use case.

Links and References

Discussion