Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

This node integrates with the Typebot service via the Evolution API, allowing users to manage and interact with Typebot instances. It supports operations such as creating, updating, deleting, starting Typebots, checking their status, managing sessions, and changing session statuses. This node is useful for automating chatbot workflows, managing chatbot sessions, and integrating chatbot interactions within larger automation processes.

Use Case Examples

  1. Create a new Typebot instance with specific triggers and session settings.
  2. Start a Typebot session for a given recipient with custom variables.
  3. Fetch and manage active sessions of a Typebot.
  4. Update or delete an existing Typebot configuration.

Properties

Name Meaning
Instance Name The name of the instance that will send the message, used to identify the sender.
What Do You Want to Do The specific Typebot operation to perform, such as create, update, delete, start, or manage sessions.
Typebot ID The identifier of the Typebot to search for or modify; optional for some operations.
Typebot API URL The URL endpoint of the Typebot API to interact with.
Typebot Name The name of the Typebot flow to be used or managed.
Trigger Type Defines how the Typebot is triggered, either by a keyword or all messages.
Trigger Operator The operator used to match the trigger keyword, such as contains, equals, starts with, ends with, or regex.
Trigger The word, phrase, or regex pattern used to start the Typebot.
Expires In (Minutes) Duration in minutes after which the bot deactivates if no answers are received.
Ending Keyword The word or phrase used to close the bot session.
Default Message Delay (in Milliseconds) Delay in milliseconds before the bot sends a message.
Ending Keyword (Unknown Message) Message shown when the bot does not recognize the input.
Listen to Messages Sent by Me Whether the bot listens to messages sent by the current instance.
Pause the Bot When I Send a Message Whether to pause the bot when the current instance sends a message.
Keep the Bot Session Open Whether to keep the bot session open after a conversation ends.
Wait Time (in Seconds) Time the bot waits to join multiple messages into one after receiving a message.
Recipient Number The recipient's RemoteJid identifier for starting or changing session status.
Start Session Flag to enable or disable starting a session with the Typebot.
Variables Custom variables to send to the Typebot during session start.
Status The status to set for a Typebot session, such as opened, paused, or closed.

Output

JSON

  • response - The JSON response from the Evolution API for the requested Typebot operation.

Dependencies

  • Evolution API endpoint

Troubleshooting

  • Ensure the Typebot API URL is correct and accessible to avoid connection errors.
  • Verify that the Typebot ID is valid when performing operations that require it.
  • Check that required parameters for each operation are provided to prevent validation errors.
  • Authentication errors may occur if the API key or credentials for the Evolution API are missing or incorrect.

Links

Discussion