Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node named "Evolution API" provides integration capabilities with the Evolution API service. It allows users to perform various operations related to managing Flowise bots and their sessions. Typical use cases include creating, updating, deleting, and querying Flowise bots, as well as managing session statuses and fetching session data. This node is beneficial for automating chatbot workflows, monitoring bot sessions, and controlling bot behavior programmatically.

Practical examples:

  • Creating a new Flowise bot instance with specific trigger keywords and timeout settings.
  • Updating an existing Flowise bot's configuration such as its API URL, API key, or trigger parameters.
  • Fetching all Flowise bots or a specific one by ID to monitor their status.
  • Changing the status of a bot session (e.g., opening, pausing, or closing a session).
  • Retrieving active sessions from Flowise for analysis or reporting.

Properties

Name Meaning
Nome Da Instancia The name of the Flowise instance that will send messages. Required for all operations.
O Que Deseja Fazer The operation to perform on the Flowise integration. Options: Add Flowise, Verify Flowise, Update Flowise, Delete Flowise, Search Session in Flowise, Change Session Status in Flowise.
ID Do Flowise The ID of the Flowise bot to target. Leave empty to fetch all bots. Required for update, find, delete, fetch sessions, and change status operations.
Url Do Flowise The URL endpoint of your Flowise instance. Required for create and update operations.
ApiKey Do Flowise The API key for authenticating with your Flowise bot. Required for create and update operations.
Tipo De Gatilho Trigger type for the bot. Options: Keyword, All. Used in create and update operations.
Operador Do Gatilho Trigger operator defining how the trigger keyword is matched. Options: Contains, Equals, Starts With, Ends With, Regex. Only applicable if trigger type is Keyword.
Gatilho The keyword, phrase, or regex pattern used as a trigger to start the Flowise bot. Required if trigger type is Keyword.
Expira Em (Minutos) Number of minutes without response after which the bot should be deactivated. Required for create and update operations.
Palavra Chave De Finalização The keyword or phrase used to close the bot session. Required for create and update operations.
Delay Padrão Da Mensagem (Em Milésimos) Default delay in milliseconds before sending a message. Required for create and update operations.
Palavra Chave De Finalização (unknownMessage) Message shown when the bot does not recognize the input. Required for create and update operations.
Escuta Mensagens Enviadas Por Mim Boolean flag indicating whether the bot listens to messages sent by the user themselves.
Pausa O Bot Quando Eu Enviar Uma Mensagem Boolean flag indicating whether the bot pauses when the user sends a message.
Mantem a Sessão Do Bot Aberta Boolean flag indicating whether to keep the bot session open continuously.
Tempo De Espera (Em Segundos) Time in seconds the bot waits for additional messages after receiving one, then combines them into a single message. Required for create and update operations.
Numero Do Destinatario The remote JID (identifier) of the recipient. Required for changing session status.
Status The status to set for a session. Options: Opened, Paused, Closed. Required for changing session status.

Output

The node outputs JSON data representing the result of the requested operation. The structure varies depending on the operation performed but generally includes details about Flowise bots or sessions, such as bot IDs, configurations, session statuses, and other metadata returned by the Evolution API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating requests to the Flowise API.
  • Needs the base URL of the Flowise instance to direct API calls.
  • The node depends on the Evolution API service being accessible at the provided URL.
  • No additional environment variables or external services are explicitly required beyond the API key and URL.

Troubleshooting

  • Common issues:

    • Invalid or missing API URL or API key will cause authentication failures.
    • Providing an incorrect Flowise bot ID may result in "not found" errors.
    • Using unsupported operations or mismatched resource-operation combinations will throw errors indicating unsupported operations.
    • Missing required parameters like trigger keywords or expiration times can cause validation errors.
  • Error messages:

    • "Operação não suportada." means the selected operation is not supported for the chosen resource; verify the operation and resource selections.
    • API authentication errors typically indicate invalid or missing API keys; ensure correct credentials are configured.
    • Network or connectivity errors suggest issues reaching the Flowise API URL; check network access and URL correctness.
  • Resolutions:

    • Double-check all required fields are filled correctly according to the operation.
    • Confirm API keys and URLs are valid and have proper permissions.
    • Use the node's test button (if available) to validate connectivity and basic functionality before running full workflows.

Links and References

Discussion