Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The Evolution Bot node allows users to manage and interact with Evolution Bot instances via the Evolution API. It supports creating, finding, updating, deleting bots, as well as managing bot sessions and their statuses. This node is useful for automating chatbot lifecycle management and session control within workflows.

Common scenarios include:

  • Automating the creation of new Evolution Bots with specific triggers and behaviors.
  • Querying existing bots to retrieve their configurations or sessions.
  • Updating bot settings such as triggers, messages, and session timeouts.
  • Deleting bots that are no longer needed.
  • Managing session states (open, paused, closed) for active conversations.

Practical example:

  • A customer support workflow could create an Evolution Bot that listens for certain keywords in incoming messages and responds accordingly, with automatic session timeout and pause/resume capabilities.

Properties

Name Meaning
Instance Name The name of the instance that will send the message.
What Do You Want To Do Choose the operation to perform with the Evolution Bot integration: Add, Check, Update, Delete Evolution Bot; Fetch Sessions; Change Session Status.
Evolution Bot ID The unique identifier of the Evolution Bot to find, update, delete, fetch sessions, or change status. Leave empty to search all when applicable.
Evolution Bot API URL The base URL of your Evolution Bot API endpoint. Required for creating or updating a bot.
Evolution Bot ApiKey The API key used to authenticate requests to the Evolution Bot API. Required for creating or updating a bot.
Trigger Type Defines how the bot is triggered: by a keyword or all messages.
Trigger Operator The operator used to match the trigger keyword: contains, equals, starts with, ends with, regex, or none.
Trigger The word, phrase, or regex pattern used to start the Evolution Bot when Trigger Type is "keyword".
Expires In (Minutes) Number of minutes without responses after which the bot should be deactivated.
Finish Keyword The word or phrase used to close the bot session. Default is "#exit".
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 the bot waits for additional messages after receiving one, merging them into a single message.
Recipient Number The remote JID (identifier) of the recipient whose session status is being changed. Required for changing session status.
Status The session status to set: opened, paused, or closed. Used when changing session status.
Ignored JIDs List of JIDs (identifiers) that the bot will ignore.

Output

The node outputs JSON data representing the result of the performed operation. Depending on the operation, this may include:

  • Details of created or updated Evolution Bots.
  • Lists of bots or sessions retrieved.
  • Confirmation of deletion or status changes.
  • Session information including current state and metadata.

No binary data output is indicated.

Dependencies

  • Requires access to the Evolution API endpoint specified by the user.
  • Requires an API key credential for authenticating requests to the Evolution API.
  • No other external dependencies are indicated.

Troubleshooting

  • Unsupported operation error: If the selected operation is not supported for the resource, the node throws an error indicating the unsupported function. Ensure the correct operation is chosen.
  • Missing required parameters: Operations like create or update require API URL and API key; missing these will cause failures.
  • Invalid Evolution Bot ID: For operations requiring a bot ID, providing an incorrect or non-existent ID will likely result in errors or empty results.
  • Session status changes: Changing session status requires a valid recipient number and status; invalid inputs may cause errors.
  • API connectivity issues: Network problems or incorrect API URLs will prevent successful calls.

To resolve errors:

  • Verify all required fields are filled correctly.
  • Confirm API credentials and URLs are valid.
  • Check network connectivity to the Evolution API.
  • Use correct operation-resource combinations.

Links and References

Discussion