Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

The Evolution Bot node allows users to manage and interact with Evolution Bot instances via the Evolution API. It supports operations such as creating, finding, updating, deleting bots, fetching sessions, and changing session statuses. This node is useful for automating chatbot lifecycle management and session handling in customer support or conversational AI workflows.

Typical use cases include:

  • Creating a new Evolution Bot instance configured with specific triggers and behaviors.
  • Querying existing bots to retrieve their details.
  • Updating bot configurations dynamically based on business needs.
  • Deleting bots that are no longer needed.
  • Fetching active or past chat sessions managed by the bot.
  • Changing the status of a bot session (e.g., opening, pausing, closing) to control conversation flow.

For example, a customer support team could automate the creation of bots tailored to different product lines, monitor ongoing chat sessions, and programmatically pause or close sessions based on user interactions.

Properties

Name Meaning
Instance Name The name of the Evolution Bot instance that will send messages.
What Do You Want To Do Operation to perform with the Evolution Bot integration. Options: Add Evolution Bot, Check Evolution Bot, Update Evolution Bot, Delete Evolution Bot, Fetch Session In Evolution Bot, Change Session Status In Evolution Bot.
Evolution Bot ID Identifier of the Evolution Bot to search, update, delete, or fetch sessions for. Leave blank to search all (where applicable).
Evolution Bot API URL The base URL of the Evolution Bot API endpoint. Required for creating or updating a bot.
Evolution Bot API Key API key credential for authenticating requests to the Evolution Bot API. Required for creating or updating a bot.
Trigger Type Defines how the bot is triggered. Options: Keyword, All.
Trigger Operator Operator used to match the trigger keyword. Options: Contains, Equals, Starts With, Ends With, Regex, None (for create/update operations).
Trigger The word, phrase, or regex pattern used to trigger the Evolution Bot. Required when Trigger Type is Keyword.
Expires In (Minutes) Duration in minutes without responses after which the bot should be deactivated.
Keyword To Finish 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 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 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) Debounce time to wait for additional messages before processing, joining multiple messages into one.
Recipient Number RemoteJid (recipient identifier) for changing session status. Required for changing session status operation.
Status Status to set for the session. Options: Opened, Paused, Closed. Required for changing session status operation.
Ignored JIDs List of JIDs (user identifiers) that the bot should ignore.

Output

The node outputs JSON data representing the result of the selected operation. The structure varies depending on the operation:

  • For creation, update, or deletion operations, the output typically includes confirmation details or the updated bot object.
  • For find operations, it returns one or more Evolution Bot objects matching the query.
  • For fetching sessions, it returns session data related to the specified bot.
  • For changing session status, it returns the updated session status confirmation.

No binary data output is indicated.

Dependencies

  • Requires an active Evolution Bot API endpoint URL.
  • Requires an API key credential for authenticating requests to the Evolution Bot API.
  • The node depends on n8n's HTTP request capabilities and proper configuration of credentials.
  • No other external dependencies are indicated.

Troubleshooting

  • Invalid or missing API URL or API Key: Ensure the Evolution Bot API URL and API key are correctly provided for create and update operations; otherwise, authentication or connection errors will occur.
  • Unsupported operation error: If an unsupported operation is selected, the node throws an error indicating the function is not supported.
  • Missing required parameters: Operations like update, delete, fetch sessions, and change status require the Evolution Bot ID or recipient number; omitting these may cause errors or empty results.
  • Trigger configuration errors: When using keyword triggers, ensure the trigger value and operator are correctly set; invalid regex patterns can cause failures.
  • Session status changes: Setting an invalid status or incorrect recipient number may lead to errors.
  • Timeouts or network issues: Verify network connectivity to the Evolution Bot API endpoint.

Links and References

Discussion