Evolution API

Interact with Evolution API

Actions64

Overview

This node integrates n8n with the Evolution API, specifically targeting the "Integração" resource and the "Chatwoot" operation. It allows users to configure and manage Chatwoot integration settings for a given instance, such as enabling/disabling the integration, setting up account details, importing contacts or messages, and customizing inbox and contact information.

Common Scenarios:

Automating the setup or update of Chatwoot integration for different instances.
Enabling or disabling Chatwoot features programmatically.
Importing contacts or messages into Chatwoot from other systems.
Customizing Chatwoot inboxes and contact profiles during onboarding or migration processes.

Practical Example:
A business using n8n can automate the process of connecting new client instances to their Chatwoot account, ensuring all necessary configuration (like tokens, URLs, and import options) is set up without manual intervention.

Properties

Below are the input properties relevant to the "Integração" resource and "Chatwoot" operation:

Display Name	Type	Meaning
Nome Da Instancia	String	The name of the instance that will send the message. Required.
O Que Deseja Fazer	Options	Choose between activating/deactivating Chatwoot or verifying Chatwoot.
Ativar Chatwoot	Boolean	Enable or disable integration with Chatwoot.
Link Do Chatwoot	String	The URL of the Chatwoot instance. Required.
ID Da Conta Do Chatwoot	String	The Chatwoot account ID. Required.
Token De Admin Do Chatwoot	String	The admin token for Chatwoot (password field). Required.
Assinatura Do Agente Do Chatwoot	Boolean	Enable or disable the Chatwoot agent signature.
Reabrir Mensagens No Chatwoot	Boolean	Enable or disable reopening messages in Chatwoot.
Iniciar Conversas Como Pendentes No Chatwoot	Boolean	Start conversations as pending in Chatwoot.
Importar Contatos Para O Chatwoot	Boolean	Import contacts into Chatwoot.
Nome Da Inbox Do Chatwoot	String	(Optional) Name of the Chatwoot inbox.
Mesclar Contatos Brasileiros No Chatwoot	Boolean	Merge Brazilian contacts in Chatwoot.
Importar Mensagens Para O Chatwoot	Boolean	Import messages into Chatwoot.
Importar Mensagens De Quantos Dias Para O Chatwoot	Number	(Optional) Number of days to limit message import into Chatwoot.
Criar Caixa De Entrada	Boolean	Automatically create an inbox.
Nome Do Contato De QRCode No Chatwoot	String	(Optional) Name for the QRCode contact in Chatwoot.
Url Do Logo Para O Contato No Chatwoot	String	(Optional) URL for the logo to use for the contact in Chatwoot.

Output

The node outputs a JSON array containing the result of the Chatwoot integration operation. The structure of the output depends on the specific action performed (e.g., setting or verifying Chatwoot integration), but it will always be a JSON object or array of objects reflecting the response from the Evolution API regarding the Chatwoot configuration.

Example Output Structure:

[
  {
    "success": true,
    "message": "Chatwoot integration updated successfully",
    "details": {
      "instanceName": "...",
      "chatwootUrl": "...",
      // ...other relevant fields
    }
  }
]

Note: Actual fields may vary depending on the operation and API response.

Dependencies

External Service: Requires access to the Evolution API and a valid Chatwoot instance.
API Credentials: Needs an "evolutionApi" credential configured in n8n.
Environment: The node expects the Evolution API to be reachable at https://doc.evolution-api.com/api-reference.

Troubleshooting

Common Issues:

Missing or Invalid Credentials: If the required "evolutionApi" credentials are not set or are incorrect, the node will fail to authenticate.
Unsupported Operation: If an unsupported operation is selected, the node throws an error indicating the function is not supported for the chosen resource/operation.
Required Fields Missing: If required fields (such as instance name, Chatwoot URL, account ID, or admin token) are missing, the API call will likely fail.

Error Messages:

"Operação não suportada."
Resolution: Ensure you have selected a valid combination of resource and operation.
API errors related to authentication or missing parameters will be returned as part of the output JSON; check the "message" or "error" fields for details.