Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This n8n custom node, Evolution API, provides integration with the Evolution API platform, specifically targeting the "Integração" resource and its "Typebot" operation. It enables users to manage and interact with Typebot instances—such as creating, updating, starting, or changing their status—within automated workflows. Typical use cases include automating chatbot flows, managing bot sessions, and integrating Typebot actions into broader business processes.

Practical examples:

  • Automatically start a Typebot session for new customer inquiries.
  • Update Typebot configurations based on workflow triggers.
  • Fetch or change the status of existing Typebot sessions programmatically.

Properties

Below are the input properties relevant to the Integração → Typebot operation:

Display Name Type Meaning/Description
Nome Da Instancia string The name of the instance that will send the message. Required.
O Que Deseja Fazer options Selects the specific Typebot action (e.g., Add, Verify, Update, Delete, Start, Fetch Sessions, Change Status).
ID Do Typebot string The ID of the Typebot to target; leave empty to fetch all. Used in several sub-operations.
URL Da API Do Typebot string The API URL of your Typebot. Required for create, update, and start operations.
Nome Do Typebot string The name of your Typebot flow. Required for create, update, and start operations.
Tipo De Gatilho options Trigger type: Keyword or All. Used for create/update.
Operador Do Gatilho options Trigger operator: Contains, Equals, Starts With, Ends With, Regex. Used when trigger type is Keyword.
Gatilho string The keyword/phrase or regex used as a trigger to start the Typebot. Required for certain operations.
Expira Em (Minutos) number Minutes of inactivity before the bot is deactivated. Required for create/update.
Palavra Chave De Finalização string Keyword/phrase to close the bot. Required for create/update.
Delay Padrão Da Mensagem (Em Milésimos) number Default message delay in milliseconds. Required for create/update.
Palavra Chave De Finalização string Phrase used for unrecognized messages. Required for create/update.
Escuta Mensagens Enviadas Por Mim boolean Whether to listen to messages sent by yourself. Used for create/update.
Pausa O Bot Quando Eu Enviar Uma Mensagem boolean Whether to pause the bot when you send a message. Used for create/update.
Mantem a Sessão Do Bot Aberta boolean Whether to keep the bot session open. Used for create/update.
Tempo De Espera (Em Segundos) number Time to wait for additional messages before combining them. Required for create/update.
Numero Do Destinatario string Recipient's remoteJid. Required for start/change status operations.
Iniciar Seção boolean Whether to enable or disable integration with Chatwoot. Used for start operation.
Variáveis fixedCollection Variables to send to Typebot (name/value pairs). Used for start operation.
Status options Session status: Opened, Paused, Closed. Used for change status operation.

Note: Some properties only appear for specific sub-operations within "Typebot".

Output

The output is a JSON array containing the results of the selected Typebot operation. The structure of each item in the array depends on the specific sub-operation performed (e.g., creation result, session details, status confirmation).

Example output structure:

[
  {
    "success": true,
    "message": "Typebot started successfully",
    "data": {
      "typebotId": "12345",
      "sessionId": "abcde",
      // ...other fields depending on the operation
    }
  }
]
  • For fetch/list operations, the data field may be an array of objects.
  • For create/update/delete, it typically contains confirmation and relevant IDs.

If the node outputs binary data (not typical for this operation), it would represent files or media associated with the Typebot session.

Dependencies

  • External Service: Requires access to the Evolution API and the Typebot API endpoint.
  • API Key/Credentials: Needs valid credentials configured in n8n under the name evolutionApi.
  • n8n Configuration: Ensure the credential is set up and the base URL matches your Evolution API environment.

Troubleshooting

Common issues:

  • Missing or invalid credentials: Ensure the evolutionApi credential is correctly configured in n8n.
  • Unsupported operation error: If you select an unsupported combination of resource and operation, you may see:
    • "Operação não suportada."
      Resolution: Double-check that the chosen operation is available for the selected resource.
  • Required property missing: If a required field is not provided, the node may throw a validation error.
  • Incorrect API URL: Providing an incorrect Typebot API URL can lead to connection failures.

Links and References

For best results, always verify which sub-operation you need and provide all required fields as indicated above.

Discussion