Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

The node named "Evolution API" provides integration with the Evolution API service, allowing users to perform various operations on different resources. Specifically for the Integration resource and the Flowise operation, it enables managing Flowise bots and their sessions. This includes creating, updating, deleting, finding Flowise bots, fetching sessions, and changing session statuses.

Common scenarios where this node is beneficial include automating chatbot management workflows, integrating Flowise bot lifecycle controls into larger automation pipelines, and monitoring or controlling active chat sessions programmatically.

Practical examples:

  • Automatically create or update a Flowise bot configuration when deploying new chatbot versions.
  • Fetch active sessions to analyze user interactions or trigger follow-up actions.
  • Change the status of a bot session (open, pause, close) based on external events or business logic.

Properties

Name Meaning
Instance Name The name of the instance that will send the message.
What Do You Want To Do Options to perform with the Flowise integration: Add Flowise, Check Flowise, Update Flowise, Delete Flowise, Fetch Session In Flowise, Change Session Status In Flowise.
Flowise ID The Flowise bot ID to search for or operate on; leave blank to target all (used in find, update, delete, fetch sessions, change status).
Flowise URL The URL endpoint of your Flowise instance (required for create and update operations).
Flowise API Key The API key for authenticating with the Flowise bot (required for create and update operations).
Trigger Type Defines how the bot is triggered: by keyword or all messages.
Trigger Operator When using keyword trigger type, defines how the trigger word/phrase is matched: contains, equals, starts with, ends with, regex.
Trigger The word, phrase, or regex pattern used as a trigger to start the Flowise bot (required if trigger type is keyword).
Expires In (Minutes) Number of minutes without responses after which the bot should be deactivated.
Keyword To Finish The word or phrase used to close the bot session.
Default Message Delay (In Milliseconds) Delay time in milliseconds before the bot sends a message.
Unknown Message The default message sent when the bot does not recognize input.
Listen To Messages Sent By Me Boolean flag indicating whether the bot listens to messages sent by the user themselves.
Pause The Bot When I Send A Message Boolean flag indicating whether the bot should pause when the user sends a message.
Keep The Bot Session Open Boolean flag indicating whether to keep the bot session open indefinitely.
Wait Time (In Seconds) Debounce time the bot waits for additional messages before processing them together.
Recipient Number The remote JID (identifier) of the recipient (required for changing session status).
Status The status to set for a session: opened, paused, or closed (used in change session status operation).

Output

The node outputs JSON data representing the result of the requested operation on the Flowise integration. This typically includes details about the created, updated, found, or deleted Flowise bots or session information depending on the operation performed.

If the operation involves fetching sessions or changing session status, the output reflects the current state or confirmation of the action.

No binary data output is indicated in the source code.

Dependencies

  • Requires an active Flowise instance accessible via a provided URL.
  • Requires a valid API key credential for authenticating requests to the Flowise API.
  • The node depends on the Evolution API service infrastructure and its endpoints.
  • Proper configuration of credentials and network access to the Flowise API is necessary.

Troubleshooting

  • Operation not supported error: Occurs if an unsupported operation is selected for the resource. Ensure the operation matches one of the supported options.
  • Authentication failures: If API key or URL is incorrect or missing, requests will fail. Verify credentials and endpoint URLs.
  • Missing required parameters: Some operations require specific fields like Flowise ID or recipient number; ensure these are provided.
  • Timeouts or connectivity issues: Network problems can prevent communication with the Flowise API.
  • Invalid trigger patterns: Using malformed regex or unsupported trigger operators may cause errors or unexpected behavior.

To resolve these issues, double-check parameter values, ensure correct API keys, verify network connectivity, and consult Flowise API documentation for valid inputs.

Links and References

Discussion