> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://ajuda.notificacoesinteligentes.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# N8N | Guia de uso, autenticação e visão geral


||| Recomendamos que esta integração seja feita por alguém que domine a linguagem de programação.

### ${color}[#ad65c8](IDEIA DE NÓ: Como funciona e o que esperar?)
 
* O Node do NI (Notificações Inteligentes) é uma ferramenta que permite integrar e automatizar algumas das funcionalidades da sua conta NI diretamente nos seus fluxos de trabalho (workflows).
* A ideia central é que você pode manipular os principais dados da sua plataforma NI (como Integrações, e Leads) usando operações padronizadas (CRUD: Criar, Buscar, Atualizar e Deletar). A chave para essa manipulação são os Identificadores Únicos (IDs).
**&#160;**
###### ${color}[#ad65c8](PRINCIPAIS CONCEITOS:)
 
 **Base de Operação**: Quase todas as operações no Node giram em torno de um ID.

* Para gerenciar uma Integração, você precisa do seu ID.
* Para editar um Lead, você precisa do ID do Lead.
 
###### ${color}[#ad65c8](TRATAMENTO DE ERROS E CONFIRMAÇÕES:)
 
* **Confirmação de Sucesso:** Todas as operações de criação, edição e exclusão são validadas pela plataforma. Ao serem bem-sucedidas, retornam uma mensagem de confirmação explícita, garantindo ao usuário que a ação foi concluída conforme esperado.
 

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/successmessage_1rap3qp.png)

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/updatemessage_s5oteh.png)

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/createmessage_ls9l3p.png)

###### ${color}[#000000](Em caso de falha, o node fornece respostas de erro detalhadas e estruturadas, incluindo:)

* **Descrição do Erro:** Uma mensagem legível que explica a natureza do problema.
* **Código de Erro HTTP:** O código de status padrão, permitindo uma depuração técnica eficiente e a construção de lógicas condicionais robustas dentro do fluxo do n8n.
 
Quando relacionado a alguma regra própria da API, na maioria dos casos ela retorna o motivo do erro detalhado, deixando ainda mais claro.


![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/detailedmessageerror_teux36.png)

Em todos os erros são retornados o código de erro. No caso de exemplo abaixo, retornou 404 (Not Found) pois não encontrou nenhum ID relacionado ao que tentamos apagar na conta.


![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/errormessage_1nc6w13.png)

###### ${color}[#ad65c8](DADOS ADICIONAIS:)

*  Além dos IDs, o Node permite trabalhar com uma gama de dados complementares (opcionais) para enriquecer suas automações, como Tags, Variáveis Customizadas, Filtros (Filters) e Relacionamentos (Include Relationships).
* Em campos de busca por exemplo, caso plausível, existe a opção de receber dados adicionais na requisição.
* Filtros (Filters) permitem a filtragem de dados a serem recebidos. Pode-se filtrar por um ou mais de um filtro ao mesmo tempo.

 
![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/filtersexample_6m157p.png)

Já a Inclusão de Relacionamentos (Include Relationships) permite adicionar mais dados a serem recebidos pela API. Também pode ser usado mais de uma opção para fazer a busca:
 

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/includeexample_19nesk8.png)

 
Em resumo, o Node transforma a API do NI em blocos visuais e intuitivos no n8n, onde a principal moeda de operação são os IDs, permitindo que você construa automações complexas e personalizadas para gerenciar sua comunicação e base de contatos de forma satisfatória.
 
###### ${color}[#ad65cd](GUIA DE AUTENTICAÇÃO DO NÓ DO NOTIFICAÇÕES INTELIGENTES:)
 
Este guia irá te ajudar a gerar e configurar sua API Key (Bearer Token) para autenticar e utilizar todas as funcionalidades do seu Node do NI de forma segura.
 
###### ${color}[#ad65c8](Dentro do Notificações Inteligentes:)
 
1. Abra seu navegador e acesse o site Notificações Inteligentes (https://notificacoesinteligentes.com)
2. Clique em Entrar e faça login com a sua conta.
 
Certifique-se de usar a conta correta que tem acesso às Organizações que deseja gerenciar via API.
 
###### ${color}[#ad65cf](Gerando a API Key - BEARER TOKEN: ) 
 
1. Após login, no menu superior, clique em Organizações.
2. Selecione a organização desejada.
3. Acesse Configurações.
4. Procure a seção Chave de API.
5. Clique em Gerar nova chave.
6. Uma caixa de diálogo será exibida:
 
 ![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/token_6ynuck.png)

* Marque a caixinha confirmando que você guardou a chave em um local seguro.
* Clique em Concluir.
 
A chave gerada será usada como Bearer Token para autenticação do Node.

||| Atenção: Guarde essa chave com segurança! Não compartilhe publicamente.
**&#160;**
### ${color}[#ad65c8](AUTENTICANDO O NÓ DO NI:)

1. No seu ambiente de integração (n8n), abra o**&#160;"Custom Node".**

2. Localize o campo "**Create new Credential / Bearer Token"**.


![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/credentialfield_wjeczy.png)

3. Cole a chave gerada no site da Notificações Inteligentes.
 
 
![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/successexample_1epkvhr.png)

4. Salve as configurações.
5. Caso houver algum problema com a chave API, uma mensagem de erro aparecerá.

 ![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/errorexample_2folot.png)

Seu Node está agora pronto para se comunicar de forma segura com a API.
 
6. Caso tenha mais de uma organização, é possível adicionar mais de uma chave e organizar as credenciais conforme cada organização. Para facilitar a identificação basta renomear cada credencial.

 ![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/credentialrename_1ycjawc.png)

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/differentcredentials_nrcjtq.png)
 
### ${color}[#ad65c8](TESTANDO A CONEXÃO:)
 
1. Crie uma ação de teste no Node, como "Get All Integrations".
2. Execute a ação.
3. Se tudo estiver correto, você verá os dados retornados da API.
 

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/testingtoken_1o8i056.png)

###### ${color}[#000000](Caso ocorra algum erro de autenticação, verifique se)${color}[#ad65c8](**:**)

* O Bearer Token foi copiado corretamente.
* A chave não expirou.
* Sua conta tem permissão para acessar a organização escolhida.
 
###### ${color}[#b071da](PRONTO!)
 
Agora você pode utilizar seu Node para criar, editar, excluir ou consultar variáveis customizadas com segurança, utilizando sua API Key (Bearer Token).

###### ${color}[#ad65cd](GUIA DE USO: RESOURCE LEADS):
 
* O recurso Leads permite cadastrar, buscar, editar, apagar e gerenciar listas de leads (contatos) em sua plataforma diretamente pelo n8n, com suporte a variáveis customizadas, tags e filtros avançados.
 
### ${color}[#ad65cf](| OPERAÇÕES DISPONÍVEIS:)
 
###### ${color}[#a056c8](CREATE LEAD:)

Cria um novo lead (contato) no sistema.
 
###### ${color}[#ad65cd](CAMPOS OBRIGATÓRIOS:)

* **Name**: Nome completo do lead.
* **Phone**: Número de telefone, incluindo DDD e código de região.
* **Email**: Endereço de e-mail do lead.

###### ${color}[#ad65cd](CAMPOS OPCIONAIS:)

* **Notes**: Observações adicionais sobre o lead.
* **Custom Variables:** Permite adicionar variáveis extras personalizadas para cada lead (ex: CPF, data de nascimento, etc).
* **Tags:** Adicione palavras-chave para agrupar ou categorizar leads (ex: "cliente VIP", "prospecto").
* **Tracking Data:** Adiciona dados rastreáveis sobre determinadas ações em alguns sites.
 
###### ${color}[#ad65cd](COMO USAR:)

Selecione o **"Resource Lead**", depois “**Create**” preencha os campos obrigatórios e, se desejar, inclua notas, tags ou variáveis customizadas. Execute para cadastrar o lead.
 
###### ${color}[#ad65cd](PONTOS IMPORTANTES:)

Caso queira adicionar uma variável customizada, o valor do "**SLUG"** e o "**VALUE"** será necessário.
 
||| Atenção: o campo "value" da "custom variable" tem que ser sempre do tipo correto da variável customizada. Uma variável customizada do tipo CPF, tem que conter um CPF. Não pode conter texto.
 

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/createleadexample_qh5ea.png)

###### ${color}[#ad65cd](UPDATE LEAD:)

Permite atualizar os dados de um lead existente.
 
###### ${color}[#ad65cd](CAMPOS OBRIGATÓRIOS:)

* **Lead ID**: Identificador do lead a ser editado.
* **Name:** Nome atualizado do lead.
* **Email:** E-mail atualizado do lead.
 
###### ${color}[#ad65cd](CAMPOS OPCIONAIS:)

Atualize ou adicione observações.

###### ${color}[#ad65c8](COMO USAR:)

Selecione o "**Resource Lead**", depois “**Update Lead**” preencha os campos obrigatórios e, se desejar, inclua notas, ou variáveis customizadas. Execute para cadastrar o lead.

* **Notes**: Atualize ou adicione observações.
* **Custom Variables**: Altere ou adicione variáveis personalizadas.
 

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/updateleadexample_hnm4wu.png)

###### ${color}[#ad65c8](CREATE OR UPDATE LEAD:)

Permite criar ou atualizar os dados de um lead existente.
 
A API analisa o número de telefone inserido pra analisar se o lead existe ou não, automaticamente. Se o lead não existir é criado um lead, se o lead existir ele é atualizado com os novos dados inseridos.
 
||| Atenção: o campo “Phone” deve conter o código de país juntamente com o “+” antes dos dados de telefone.


![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/createupdateexamplenew_1y8je1d.png)

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/createupdateexamplenew-2_1bzuc3e.png)

###### ${color}[#ad65c8](ADD TAGS TO LEAD:)

Adiciona **Tags** a um determinado lead.
 
###### ${color}[#ad65cd](CAMPOS OBRIGATÓRIOS:)

* **Lead ID:** Identificador do lead a ser editado.
* **Tags:** Tags a serem adicionadas.
 
###### ${color}[#ad65cd](COMO USAR:)

Selecione "**Add Tags to Lead**" preencha os campos “**Lead ID**” e escolha quais tags adicionar no campo “**Tags**”.


![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/addtagslead_ucprcz.png)
 
###### ${color}[#ad65cd](UPDATE TAGS FROM LEAD:)

Atualiza as Tags de um lead. Nesse caso as tags que existirem no lead, serão removidas e substituídas pelas tags colocadas no campo “Tags”.
 
###### ${color}[#ad65cd](CAMPOS OBRIGATÓRIOS):

* **Lead ID:** Identificador do lead a ser editado.
* **Tags:** Novas tags que vão atualizar o lead.

###### ${color}[#ad65cd](COMO USAR:)

Selecione "**Update Tags from Lead**" preencha os campos “**Lead ID**” e o campo “**Tags**” e execute.


![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/updatetagslead_1wws0or.png)

###### ${color}[#ad65cd](REMOVE TAGS FROM LEAD:)

Remove as tags escolhidas de determinado lead.
 
###### ${color}[#ad65cd](CAMPOS OBRIGATÓRIOS:)

* **Lead ID:** Identificador do lead a ser editado.
* **Tags:** Novas tags que vão atualizar o lead.
 
###### ${color}[#ad65cd](COMO USAR:)

Selecione "**Remove Tags From Lead**" preencha os campos “**Lead ID**” e o campo “**Tags**” e execute.


![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/deletetagslead_2kfnxe.png)

###### ${color}[#ad65cd](GET ALL LEADS:)

Lista todos os leads cadastrados no sistema.
 
###### ${color}[#ad65cd](CAMPOS OPCIONAIS:)

* **Filters**: Permite filtrar por nome, telefone, e-mail ou tag.
* **Include Relationships**: Marque para trazer dados relacionados, como listas, tags e fonte das listas.
 
###### ${color}[#ad65cd](COMO USAR:)

Selecione "**Get All Leads**", defina os filtros desejados (ou deixe em branco para listar todos) e execute.
 
Nos exemplos abaixo, utilizamos ***sem filtragem*** e ***com filtragem*** pelo nome pra exemplificar melhor. Buscando sem filtros recebemos todos os leads, no caso 6. Filtrando pelo nome “Testando” nos é retornado apenas 2 leads com esse nome.


![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/leadgetall_130yz42.png)

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/leadgetallfiltersexample_bqa4qs.png)

###### ${color}[#ad65cd](GET LEAD BY ID:)

Retorna os dados completos de um lead específico a partir do seu identificador único.
 
###### ${color}[#ad65cd](CAMPOS OBRIGATÓRIOS:)

* **ID do Lead:** Insira o ID do lead desejado (pode ser obtido ao listar todos).
 
###### ${color}[#ad65cd](CAMPOS OPCIONAIS:)

* **Incluir Relacionamentos:** Escolha trazer listas, tags ou usuários relacionados.
 
###### ${color}[#ad65cd](COMO USAR):

* Selecione "**Get Lead by ID**", informe o ID do lead e, se quiser, marque os relacionamentos a incluir. Execute para ver detalhes completos.
 

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/leadleadidexample_nrrcnp.png)

###### ${color}[#ad65cd](DELETE LEAD:)

Remove um lead de forma permanente do sistema.
 
###### ${color}[#ad65cd](CAMPO OBRIGATÓRIO:)

* **Lead ID:** Identificador do lead a ser removido.
 
###### ${color}[#ad65cd](COMO USAR:)

Selecione "**Delete Lead**", informe o ID do lead e execute.

Uma mensagem de confirmação será exibida se a operação for bem-sucedida.
 

![](https://storage.crisp.chat/users/helpdesk/website/-/7/8/6/4/786467ca5128f400/leaddeletelead_y105ad.png)

**PARA MAIS INFORMAÇÕES SOBRE LEADS NO NI:**
Consulte: [__https://ajuda.notificacoesinteligentes.com/pt-br/article/gerenciamento-de-leads-1x8lj7m/__](https://ajuda.notificacoesinteligentes.com/pt-br/article/gerenciamento-de-leads-1x8lj7m/)
 

