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

# n8n

> Instalação do community node do ChatNorris para n8n: credenciais, operações e trigger.

O ChatNorris publica um **node verificado pelo n8n** para o [n8n](https://n8n.io) (`n8n-nodes-chatnorris`, [código aberto](https://github.com/ChatNorris/n8n-nodes-chatnorris), MIT). Ele funciona no n8n Cloud e em instâncias próprias. Diferente do Zapier —onde você monta a lógica peça por peça com um punhado de triggers e uma ação—, o node do n8n cobre a API v2 quase por completo: agentes, mensagens, conversas, leads e base de conhecimento, com paginação real e filtros por data.

> [!NOTE]
>
> Requer uma API key com acesso à API v2 — disponível nos planos **Standard** e **Premium** (veja [Introdução à API](https://docs.chatnorris.ai/pt/api-referencia/introduccion.md)).

***

## Instalar o node

**Pelo painel de nodes (n8n Cloud e versões recentes self-hosted):**

1. Em um workflow, abra o painel de nodes (botão **+**).
2. Pesquise **ChatNorris**: ele aparece como node verificado.
3. Clique em **Install**. Você precisa ser owner ou admin da instância do n8n.

**Pelo Settings (self-hosted):**

1. Acesse **Settings → Community Nodes → Install**.
2. Digite o nome do pacote: `n8n-nodes-chatnorris` e confirme.

Mais detalhes na [documentação do n8n sobre community nodes](https://docs.n8n.io/integrations/community-nodes/installation/).

***

## Configurar a credencial

1. No ChatNorris, acesse **Configurações → Chaves de API** e crie uma key.
2. No n8n, crie uma credencial do tipo **ChatNorris API**.
3. Cole a key em **API Key**. O campo **Base URL** vem com `https://app.chatnorris.ai` por padrão — você só o altera se usar um ambiente próprio.
4. A credencial sempre se autentica com `Authorization: Bearer <key>` e é testada contra `GET /api/v2/project`.

### Permissões que cada operação usa

| Operação | Scope |
| - | - |
| Chatbot: Get / Get Many · Knowledge Source: Get Many · lista suspensa de agentes | `chatbots:read` |
| Message: Send | `chat:write` |
| Conversation: Get / Get Many / Get Messages · Trigger “New Conversation” | `conversations:read` |
| Lead: Get / Get Many · Trigger “New Lead” | `leads:read` |
| Knowledge Source: Add / Delete / Resync | `chatbots:write` |

As API keys criadas em **Configurações → Chaves de API** têm acesso completo (`*`), então cobrem todas essas operações: não é preciso escolher permissões.

***

## Node “ChatNorris” (ações)

| Recurso | Operações |
| - | - |
| Chatbot | Get, Get Many |
| Message | Send — `message`, `conversation_id` opcional (para continuar uma conversa existente) e anexo opcional. Retorna `reply` e `conversation_id` |
| Conversation | Get, Get Many (filtros: agente, status, *Created After*, *Order By*), Get Messages |
| Lead | Get, Get Many (filtros: agente, *Created After*) — inclui `channel`, `contact_properties` e `custom_fields` |
| Knowledge Source | Get Many, Add (URL, texto ou FAQ), Delete, Resync |

* As operações de listagem suportam **Return All** ou **Limit**, com paginação automática (100 itens por página) — não é preciso montar um loop manual.
* O anexo de *Send Message* precisa ser uma URL retornada por `POST /api/v2/chatbots/:id/attachments` (enviar o arquivo é um passo prévio, não algo que este node resolva sozinho).
* Não há operação para atualizar um lead: a API v2 ainda não expõe esse endpoint.

### Usá-lo como ferramenta de um agente de IA

O node “ChatNorris” pode ser conectado como **tool** de um node *AI Agent* do n8n. Assim, um agente do n8n pode, por exemplo, consultar os leads de hoje ou enviar uma pergunta ao seu agente do ChatNorris e usar a resposta dele. Lembre-se de que a API key tem acesso completo à sua organização: use uma chave dedicada para esse fluxo, assim você pode excluí-la de forma independente.

***

## Node “ChatNorris Trigger” (polling)

Eventos: **New Lead** e **New Conversation**, com um filtro opcional de agente.

* Usa `created_after` e salva um cursor nos dados estáticos do workflow. Percorre todas as páginas necessárias a cada poll para não perder nada entre uma consulta e a seguinte, e remove duplicados por `id`.
* Emite os itens do mais antigo ao mais novo.
* Na primeira vez que você ativa o workflow, o trigger apenas registra o ponto de partida —ele não emite todo o histórico existente.
* Um “Execute step” manual retorna o item mais recente, útil para mapear campos sem esperar o próximo poll real.
* **New Conversation** também inclui conversas criadas pela própria API (canal `api`), por exemplo as iniciadas pela operação *Send Message*.

***

## Workflows de exemplo

* **Novo lead → CRM ou aviso no chat interno:** `ChatNorris Trigger (New Lead)` → seu CRM ou Slack, usando `{{$json.email}}` e `{{$json.contact_properties.company}}`.
* **Responder a partir de outro canal:** `Webhook` → `ChatNorris (Message → Send)` → responder com `{{$json.reply}}`, salvando o `conversation_id` para continuar a conversa na mensagem seguinte.
* **Manter a base de conhecimento atualizada:** `Schedule` → `ChatNorris (Knowledge Source → Add, URL)` para indexar uma página toda semana.

***

## Veja também

* [Introdução à API](https://docs.chatnorris.ai/pt/api-referencia/introduccion.md) — autenticação, scopes e formato de resposta.
* [Zapier](https://docs.chatnorris.ai/pt/api-referencia/zapier.md) — alternativa no-code, mais leve, para triggers e envio de mensagens.
* [Repositório do node no GitHub](https://github.com/ChatNorris/n8n-nodes-chatnorris) — código-fonte, changelog e guia de desenvolvimento.


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