Evolution API

Overview

The Instancia - Criar Instancia operation in the Evolution API n8n node is designed to create a new WhatsApp instance with customizable settings. This node is particularly useful for automating the setup of WhatsApp integrations, including advanced configurations such as Chatwoot integration, proxy usage, RabbitMQ event streaming, and webhook notifications.

Common scenarios:

• Automating onboarding of new WhatsApp numbers for customer support or marketing.
• Integrating WhatsApp with Chatwoot for unified messaging.
• Setting up webhooks or message/event streaming via RabbitMQ for real-time processing.
• Configuring proxy or custom behaviors for compliance or infrastructure needs.

Practical example:
A business wants to automatically provision WhatsApp instances for new agents, connect them to Chatwoot, and set up webhooks for message events—all triggered from an n8n workflow.

Properties

Below are the input properties supported by this operation:

Opções (Options) Sub-properties

• Chatwoot

  • ID Da Conta Do Chatwoot: String. Chatwoot account ID.
  • Token De Admin Do Chatwoot: String (password). Chatwoot admin token.
  • Link Do Chatwoot: String. URL to your Chatwoot instance.
  • Assinatura Do Agente Do Chatwoot: Boolean. Enable/disable agent signature.
  • Reabrir Mensagens No Chatwoot: Boolean. Reopen messages in Chatwoot.
  • Iniciar Conversas Como Pendentes No Chatwoot: Boolean. Start conversations as pending.
  • Importar Contatos Para O Chatwoot: Boolean. Import contacts to Chatwoot.
  • Nome Da Inbox Do Chatwoot: String. Name of the Chatwoot inbox.
  • Mesclar Contatos Brasileiros No Chatwoot: Boolean. Merge Brazilian contacts.
  • Importar Mensagens Para O Chatwoot: Boolean. Import messages to Chatwoot.
  • Importar Mensagens De Quantos Dias Para O Chatwoot: Number. Limit message import by days.
  • Nome Do Contato De QRCode No Chatwoot: String. Name for QRCode contact.
  • Url Do Logo Para O Contato No Chatwoot: String. Logo URL for contact.

• Comportamento (Behavior)

  • Rejeitar Ligações: Boolean. Automatically reject incoming calls.
  • Mensagem Ao Rejeitar: String. Message sent after rejecting a call.
  • Ignorar Grupos: Boolean. Ignore group messages.
  • Sempre Online: Boolean. Keep status always online.
  • Ler Mensagens: Boolean. Mark messages as read automatically.
  • Ler Status: Boolean. Allow viewing contact statuses.
  • Sincronizar Histórico: Boolean. Synchronize full message history.

• Proxy

  • Host Do Proxy: String. Proxy host.
  • Porta Do Proxy: String. Proxy port.
  • Protocolo Do Proxy: Options (HTTP/HTTPS). Proxy protocol.
  • Usuário Do Proxy: String. Proxy username.
  • Senha Do Proxy: String (password). Proxy password.

• RabbitMQ

  • Ativa Ou Desativa O RabbitMQ: Boolean. Enable/disable RabbitMQ integration.
  • Eventos: Multi-options. List of events to monitor and send to RabbitMQ.

• Webhook

  • Url Do Webhook: String. Webhook endpoint URL.
  • Webhook Por Eventos: Boolean. Create separate route per event.
  • Base64 No Webhook: Boolean. Send media data as base64.
  • Eventos: Multi-options. List of events to trigger webhooks.

Output

The output will be a JSON object containing the result of the instance creation request. While the exact structure depends on the API response, you can expect fields such as:

{
  "success": true,
  "instanceId": "string",
  "qrcode": "string",
  "message": "Instance created successfully",
  // ...other relevant details about the created instance
}

If binary data is involved (e.g., QR codes), it will typically be provided as a string (such as a base64-encoded image) within the JSON.

Dependencies

• External Service: Requires access to the Evolution API service.
• API Key: You must provide valid credentials for the Evolution API (configured in n8n under "evolutionApi" credentials).
• Optional Integrations: Chatwoot, RabbitMQ, and webhook endpoints if those features are enabled.

Troubleshooting

Common Issues:

• Missing Required Fields: If "Nome Da Instância" is not provided, the node will fail.

• Invalid Credentials: Incorrect or missing API key will result in authentication errors.

• Unsupported Operation: If the resource or operation is not recognized, you may see an error like:

  Operação não suportada.
  A função "instance-basic" para o recurso "instances-api" não é suportada!
  

  Resolution: Double-check that you selected the correct resource and operation.

• Network/Connectivity Errors: Ensure n8n can reach the Evolution API endpoint and any configured webhooks or proxies.

Links and References

• Evolution API Documentation
• n8n Documentation
• Chatwoot Documentation
• RabbitMQ Documentation