Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The node "Evolution API" provides integration with the Evolution API service, allowing users to perform various operations related to the "Integração" resource and specifically the "Dify" operation. This node is designed to manage Dify bots by creating, updating, deleting, querying, and controlling sessions and statuses of these bots.

Common scenarios where this node is beneficial include:

  • Automating chatbot management workflows.
  • Integrating Dify bot lifecycle operations into larger automation pipelines.
  • Monitoring and controlling chatbot sessions programmatically.
  • Updating bot triggers and behavior dynamically based on external events.

Practical examples:

  • Creating a new Dify bot instance with specific trigger keywords and session expiration settings.
  • Fetching all existing Dify bots or a specific one by ID.
  • Pausing or resuming a bot session for a particular recipient.
  • Searching active sessions within a Dify bot to analyze user interactions.

Properties

Name Meaning
Nome Da Instancia The name of the Dify bot instance that will send messages.
O Que Deseja Fazer Operation to perform on the Dify integration. Options: Add Dify, Verify Dify, Update Dify, Delete Dify, Search Session in Dify, Change Session Status in Dify.
ID Do Dify The ID of the Dify bot to target for find, update, delete, fetch sessions, or change status operations. Leave empty to query all (for find).
Url Do Dify The URL endpoint of your Dify bot API. Required for create and update operations.
ApiKey Do Dify The API key for authenticating requests to your Dify bot. Required for create and update operations.
Tipo De Gatilho Trigger type for the bot. Options: Keyword, All. Used when creating or updating a bot.
Operador Do Gatilho Trigger operator defining how the keyword matches. 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 Dify bot. Required if trigger type is Keyword.
Expira Em (Minutos) Number of minutes without responses after which the bot should be deactivated.
Palavra Chave De Finalização Keyword or phrase used to close/end the bot session.
Delay Padrão Da Mensagem (Em Milésimos) Default delay in milliseconds before sending a message from the bot.
Palavra Chave De Finalização (unknownMessage) Message or phrase sent when the bot does not recognize the input.
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.
Numero Do Destinatario The remote identifier (JID) of the recipient. Required for changing session status.
Status The status to set for a session. Options: Opened, Paused, Closed. Used when changing session status.

Output

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

  • For creation and update operations, it returns confirmation details about the Dify bot configuration.
  • For find operations, it returns one or multiple Dify bot records matching the criteria.
  • For session-related operations, it returns session information or status update confirmations.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Dify bot API.
  • Requires the URL endpoint of the Dify bot API.
  • No other external dependencies are explicitly required.
  • The node expects proper network connectivity to the specified Dify API URL.

Troubleshooting

  • Invalid or missing API key: Ensure the API key is correctly provided and has sufficient permissions.
  • Incorrect URL: Verify the Dify API URL is correct and accessible.
  • Operation not supported error: Occurs if an unsupported operation is selected; verify the operation name matches available options.
  • Missing required parameters: Some operations require specific fields (e.g., difyBotId for update/delete); ensure all required inputs are filled.
  • Timeouts or network errors: Check network connectivity and API availability.
  • Session status changes fail: Confirm the remoteJid and status values are valid and correspond to existing sessions.

Links and References

Discussion