Evolution API icon

Evolution API

Interact with Evolution API
Join our community

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, specifically focusing on the "Dify" operation. This node enables managing Dify bots by creating, finding, updating, deleting them, as well as handling sessions and changing session statuses.

Common scenarios where this node is beneficial include automating chatbot management workflows, integrating chatbots into messaging platforms, and controlling bot sessions programmatically. For example, a user can create a new Dify bot instance with specific triggers and behaviors, update its configuration, or pause/resume bot sessions based on external events.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message.
O Que Deseja Fazer Choose an action to perform with the Dify integration: Add Dify, Find 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 (used for find operation).
Url Do Dify The URL of your Dify instance (required for create and update operations).
ApiKey Do Dify The API key for your Dify bot (required for create and update operations).
Tipo De Gatilho Trigger type for the bot: Keyword or All messages (used in create and update operations).
Operador Do Gatilho Trigger operator when using keyword trigger: Contains, Equals, Starts With, Ends With, Regex (used only if trigger type is keyword).
Gatilho The word/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 and update).
Palavra Chave De Finalização The word/phrase used to close/end the bot session (default "#sair", required for create and update).
Delay Padrão Da Mensagem (Em Milésimos) Default delay in milliseconds before sending a message (required for create and update).
Palavra Chave De Finalização (unknownMessage) Message shown when input is not recognized (required for create and update).
Escuta Mensagens Enviadas Por Mim Boolean flag whether the bot listens to messages sent by the user themselves (create and update).
Pausa O Bot Quando Eu Enviar Uma Mensagem Boolean flag whether the bot pauses when the user sends a message (create and update).
Mantem a Sessão Do Bot Aberta Boolean flag whether to keep the bot session open (create and update).
Tempo De Espera (Em Segundos) Time in seconds the bot waits for additional messages before combining them into one (debounce time, create and update).
Numero Do Destinatario RemoteJid of the recipient (required for changing session status).
Status Status of the session: Opened, Paused, Closed (used for changing session status).

Output

The node outputs JSON data representing the result of the selected operation on the Dify bot or its sessions. The structure varies depending on the operation:

  • For creation, update, or deletion, it returns confirmation and details of the affected Dify bot.
  • 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 access to the Evolution API service with valid credentials (an API key credential).
  • The user must provide the Dify API URL and API key for authentication.
  • No other external dependencies are indicated.
  • Proper network connectivity to the specified Dify API endpoint is necessary.

Troubleshooting

  • Common Issues:

    • Missing or incorrect API URL or API key will cause authentication failures.
    • Providing invalid IDs for Dify bots or sessions may result in "not found" errors.
    • Incorrect trigger configurations (e.g., missing required fields when trigger type is keyword) can cause validation errors.
    • Network issues or unreachable API endpoints will cause request failures.

  • Error Messages:

    • "Operation not supported": Occurs if an unsupported operation is requested; ensure the operation name matches one of the supported options.
    • Authentication errors: Check that the API key and URL are correct and active.
    • Validation errors: Ensure all required parameters for the chosen operation are provided and correctly formatted.

Links and References

  • Dify Official Documentation (for understanding Dify bot configuration and API)
  • Evolution API documentation (if publicly available, link here)
  • n8n documentation on creating custom nodes and using API credentials

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion