Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The node named "Evolution API" is designed to interact with the Evolution API service, providing various operations grouped by resource types. Specifically for the Resource "Integração" and Operation "Dify," it enables integration with the Dify bot platform. This allows users to manage Dify bots programmatically within n8n workflows.

Common scenarios include:

  • Creating a new Dify bot instance.
  • Retrieving information about existing Dify bots.
  • Updating or deleting Dify bots.
  • Managing sessions related to Dify bots.
  • Changing the status of a Dify bot session.

Practical examples:

  • Automate the creation of a Dify bot when a new project starts.
  • Periodically check the status of Dify bots and update their configurations.
  • Pause or close bot sessions based on external triggers or workflow conditions.

Properties

Name Meaning
Nome Da Instancia The name of the Dify bot instance that will send messages.
O Que Deseja Fazer The action to perform with 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 (used in find, update, delete, fetchSessions, changeStatus operations).
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 with your Dify 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 Operator for the trigger keyword. 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 and update).
Palavra Chave De Finalização The keyword or phrase used to close/end the bot session (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 an unrecognized input is received (required for create and update).
Escuta Mensagens Enviadas Por Mim Boolean flag indicating whether the bot listens to messages sent by the user themselves (create and update).
Pausa O Bot Quando Eu Enviar Uma Mensagem Boolean flag to pause the bot when the user sends a message (create and update).
Mantem a Sessão Do Bot Aberta Boolean flag 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 (create and update).
Numero Do Destinatario The remote identifier (remoteJid) of the recipient (required for changing session status).
Status The status to set for the session. Options: Opened, Paused, Closed (used in changeStatus operation).

Output

The node outputs JSON data representing the result of the requested operation on the Dify bot or its sessions. The structure depends on the operation performed:

  • For creation, update, or deletion, it typically returns confirmation details or the updated object.
  • For retrieval operations, it returns the found Dify bot(s) or session information.
  • For session status changes, it returns the updated session status.

No binary data output is indicated.

Dependencies

  • Requires access to the Dify bot API via a valid URL and API key.
  • The node expects these credentials and URLs to be provided as input properties.
  • No other external dependencies are explicitly required.
  • Proper network connectivity to the Dify API endpoint is necessary.

Troubleshooting

  • Invalid or missing API URL or API Key: Ensure the correct URL and API key are provided for create and update operations; otherwise, authentication or connection errors will occur.
  • Unsupported operation or resource: If an unsupported operation is selected, the node throws an error stating the operation is not supported.
  • Empty or incorrect Dify ID: For operations requiring a Dify ID (find, update, delete, fetchSessions, changeStatus), ensure the ID is correctly specified; leaving it empty may cause unexpected results or errors.
  • Trigger configuration errors: When using keyword triggers, ensure the trigger value and operator are correctly set; invalid regex patterns can cause failures.
  • Session status changes: When changing session status, ensure the remoteJid and status are valid; otherwise, the API may reject the request.

Links and References

Discussion