> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wppfy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# n8n

> Automatize o WhatsApp no n8n com os nós oficiais da WppFy.

O pacote [`n8n-nodes-wppfy`](https://www.npmjs.com/package/n8n-nodes-wppfy) adiciona dois nós ao n8n:

<CardGroup cols={2}>
  <Card title="WppFy" icon="paper-plane">
    Todas as rotas desta documentação como operações: enviar mensagens, gerenciar chats, grupos, canais, etiquetas, CRM, catálogo e mais.
  </Card>

  <Card title="WppFy Trigger" icon="bolt">
    Inicia um workflow quando chegam mensagens e outros eventos do WhatsApp. O webhook é criado e removido automaticamente.
  </Card>
</CardGroup>

## Instalação

<Tabs>
  <Tab title="Pela interface">
    1. No n8n, acesse **Settings → Community Nodes**.
    2. Clique em **Install**.
    3. Digite `n8n-nodes-wppfy`, aceite o aviso e clique em **Install**.
  </Tab>

  <Tab title="Self-hosted (CLI / Docker)">
    ```bash theme={null}
    cd ~/.n8n/nodes
    npm install n8n-nodes-wppfy
    # reinicie o n8n
    ```

    No Docker, rode o comando dentro do container (ou no volume `~/.n8n/nodes`) e reinicie.
  </Tab>
</Tabs>

## Credencial

Crie uma credencial **WppFy API**:

| Campo | Valor |
| - | - |
| **Instance Token** | Token da sua instância, disponível no [painel da WppFy](https://wppfy.com/dashboard) |
| **Base URL** | `https://api.wppfy.com` (padrão) |

Ao salvar, o n8n testa a credencial com `GET /instance/status`. Cada credencial corresponde a uma instância: crie uma por número.

## Enviar mensagens (nó WppFy)

1. Adicione o nó **WppFy** ao workflow.
2. Escolha o **Resource** (por exemplo *Send Message*) e a **Operation** (por exemplo *Send text message*).
3. Preencha os campos obrigatórios. Os opcionais ficam em **Additional Fields → Add Field**.

| Parâmetro | Exemplo |
| - | - |
| Resource | Send Message |
| Operation | Send text message |
| Number | `5511999999999` ou o ID de um grupo terminado em `@g.us` |
| Text | `Olá {{ $json.nome }}!` |

<Tip>
  Campos com listas ou objetos (opções de menu, cards de carrossel, participantes de grupo) aceitam JSON. Você pode digitar o JSON ou usar uma expressão, como `{{ JSON.stringify($json.participantes) }}`.
</Tip>

<Note>
  Os placeholders da WppFy, como `{{name}}` e `{{first_name}}`, funcionam em campos de texto comuns. Dentro de uma expressão do n8n, escreva `{{ "{{name}}" }}` para que o n8n não tente interpretá-los.
</Note>

## Receber eventos (nó WppFy Trigger)

1. Adicione o nó **WppFy Trigger** e selecione a credencial.
2. Em **Events**, escolha os eventos que iniciam o workflow (padrão: *Messages*).
3. Em **Ignore Messages**, mantenha **Sent by API** se o workflow responder com o nó WppFy. Assim as próprias respostas não disparam o workflow de novo.
4. Ative o workflow.

Ao **ativar**, o nó adiciona um webhook na instância apontando para o n8n. Ao **desativar**, esse webhook é removido. Webhooks que você já tem na instância não são alterados.

Cada evento vira um item com o payload do evento (`EventType`, `message`, `chat`, `owner`...). O token da instância que vem no payload é removido por padrão; para mantê-lo, ative **Options → Include Instance Token**.

<Warning>
  O n8n precisa estar acessível pela internet para receber os eventos: n8n Cloud, ou self-hosted com `WEBHOOK_URL` público. Um n8n rodando só em `localhost` não recebe eventos.
</Warning>

## Agentes de IA

O nó **WppFy** pode ser usado como ferramenta de um **AI Agent**. Adicione o WppFy como tool, escolha a operação que o agente pode usar (por exemplo *Send text message*) e deixe o modelo preencher os campos com `$fromAI()`.

## Operações disponíveis

O nó segue os grupos da [Referência API](/pt-BR/api-reference/start-here): Instance, Proxy, Profile, Business, Calls, Send Message, Async Message, Message Actions and Search, Chats, Contacts, Blocklist, Labels, Groups and Communities, Newsletters and Channels, Quick Replies, CRM e Chatwoot Integration. A lista completa de operações está na [página do pacote no npm](https://www.npmjs.com/package/n8n-nodes-wppfy).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.