Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node integrates with the Typebot service via the Evolution API, enabling 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 include automating chatbot lifecycle management, triggering chatbots based on specific keywords or patterns, managing active sessions, and controlling chatbot behavior dynamically within 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 sessions to monitor chatbot interactions in real-time.
  • 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 Typebot integration. Options: Add Typebot, Check Typebot, Update Typebot, Delete Typebot, Start Typebot, Fetch Session In Typebot, Change Session Status In Typebot.
Typebot ID The ID of the Typebot to search for or operate on. Leave empty to search for 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 the Typebot flow to be used. Required for create, update, and start operations.
Trigger Type Defines how the bot is triggered. Options: Keyword (triggered by specific words/phrases), All (triggered by all messages).
Trigger Operator Defines the matching operator for the trigger keyword. Options: Contains, Equals, Starts With, Ends With, Regex. Applicable only if Trigger Type is Keyword.
Trigger The word, phrase, or regex pattern used to trigger the Typebot. Required if Trigger Type is Keyword.
Expires In (Minutes) Duration in minutes after which the bot should deactivate if no responses are received.
Finish Keyword Word or phrase used to close the bot session.
Default Message Delay Delay in milliseconds before the bot sends a message.
Unknown Message Message sent when the bot receives an unrecognized 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 sending a message from the user pauses the bot.
Keep The Bot Session Open Whether to keep the bot session open indefinitely.
Wait Time (In Seconds) Time in seconds the bot waits to merge multiple incoming messages into one before processing.
Recipient Number The remote identifier (e.g., phone number or chat ID) of the recipient to start or change session status. Required for start and change status operations.
Start Session Boolean flag to enable or disable starting a new session when starting the Typebot.
Variables Collection of key-value pairs representing variables to send to the Typebot when starting it.
Status The desired session status to set. Options: Opened, Paused, Closed. Used in changing session status operation.

Output

The node outputs JSON data representing the response from the Evolution API related to the requested Typebot operation. This typically includes details about the Typebot instance, session information, status updates, or confirmation of actions performed.

If the operation involves fetching sessions or checking Typebot details, the output contains structured data about those entities.

No binary data output is indicated in the source code or properties.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API base URL and endpoints to be accessible.
  • Proper configuration of the Typebot API URL and valid Typebot names/IDs is necessary.
  • No other external dependencies are explicitly required.

Troubleshooting

  • Unsupported operation error: If an unsupported operation or resource is selected, the node throws an error indicating the function is not supported. Ensure the chosen operation matches the available options.
  • Missing required parameters: Operations like create, update, and start require mandatory fields such as Typebot API URL, Typebot name, and recipient number. Missing these will cause errors.
  • Invalid Typebot ID: Providing an incorrect or non-existent Typebot ID for update, delete, or fetch operations may result in failures or empty results.
  • API connectivity issues: Network problems or invalid API credentials can cause authentication failures or timeouts.
  • Trigger misconfiguration: Incorrect trigger type or operator settings might prevent the bot from activating as expected.

To resolve these issues:

  • Verify all required parameters are correctly filled.
  • Confirm API credentials and URLs are valid and reachable.
  • Double-check Typebot IDs and names exist in the target system.
  • Review trigger settings for correctness.

Links and References

Discussion