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 enables managing 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 active chat 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 closing a bot session remotely.
  • Searching for active sessions within a Dify bot and changing their status.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message.
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 find, update, delete, fetch sessions, or change status. Leave empty to search all (only for certain operations).
Url Do Dify The URL endpoint of your Dify bot API. Required for creating or updating a Dify bot.
ApiKey Do Dify The API key for authenticating with your Dify bot. Required for creating or updating a Dify bot.
Tipo De Gatilho Trigger type for the bot. Options: Keyword, All. Used when creating or updating a Dify 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 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. Required for create/update.
Palavra Chave De Finalização The keyword or phrase used to close/end the bot session. Required for create/update.
Delay Padrão Da Mensagem (Em Milésimos) Default delay in milliseconds before sending messages. Required for create/update.
Palavra Chave De Finalização (unknownMessage) Message shown when input is not recognized. Required for create/update.
Escuta Mensagens Enviadas Por Mim Boolean indicating whether the bot listens to messages sent by the user themselves.
Pausa O Bot Quando Eu Enviar Uma Mensagem Boolean indicating whether the bot pauses when the user sends a message.
Mantem a Sessão Do Bot Aberta Boolean indicating whether to keep the bot session open.
Tempo De Espera (Em Segundos) Time in seconds the bot waits for additional messages before combining them into one. Required for create/update.
Numero Do Destinatario RemoteJid (identifier) of the recipient. Required for changing session status.
Status Status to set for the session. Options: Opened, Paused, Closed. Required for 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 retrieval operations (findDify, fetchSessionsDify), it returns arrays or objects containing the requested Dify bot(s) or session information.
  • For deletion and status change operations, it returns success/failure confirmation.

No binary data output is indicated.

Dependencies

  • Requires an API URL and API key credential for authenticating requests to the Dify bot service.
  • The node depends on the Evolution API service endpoints for Dify bot management.
  • Proper network access to the specified Dify API URL is necessary.
  • No other external dependencies are indicated.

Troubleshooting

  • Invalid or missing API credentials: Ensure the API URL and API key are correctly provided and valid.
  • Operation not supported error: Occurs if an unsupported operation is selected; verify the operation name matches supported options.
  • Empty or invalid Dify ID: For operations requiring a Dify ID, ensure the ID is correct and exists.
  • Timeouts or connectivity issues: Check network connectivity to the Dify API URL.
  • Incorrect trigger configurations: When setting triggers, ensure the trigger type and operator match the expected format (e.g., regex must be valid).
  • Session status changes fail: Verify the remoteJid and status values are correct and the session exists.

Links and References

Discussion