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.

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).

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.

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.

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.

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.

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.

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:

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.

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.

Dentro do Notificações Inteligentes:

Abra seu navegador e acesse o site Notificações Inteligentes (https://notificacoesinteligentes.com)
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.

Gerando a API Key - BEARER TOKEN:

Após login, no menu superior, clique em Organizações.
Selecione a organização desejada.
Acesse Configurações.
Procure a seção Chave de API.
Clique em Gerar nova chave.
Uma caixa de diálogo será exibida:

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.

AUTENTICANDO O NÓ DO NI:

No seu ambiente de integração (n8n), abra o "Custom Node".

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

Cole a chave gerada no site da Notificações Inteligentes.

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

Seu Node está agora pronto para se comunicar de forma segura com a API.

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.

TESTANDO A CONEXÃO:

Crie uma ação de teste no Node, como "Get All Integrations".
Execute a ação.
Se tudo estiver correto, você verá os dados retornados da API.

Caso ocorra algum erro de autenticação, verifique se:

O Bearer Token foi copiado corretamente.
A chave não expirou.
Sua conta tem permissão para acessar a organização escolhida.

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).

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.

| OPERAÇÕES DISPONÍVEIS:

CREATE LEAD:

Cria um novo lead (contato) no sistema.

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.

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.

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.

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.

UPDATE LEAD:

Permite atualizar os dados de um lead existente.

CAMPOS OBRIGATÓRIOS:

Lead ID: Identificador do lead a ser editado.
Name: Nome atualizado do lead.
Email: E-mail atualizado do lead.

CAMPOS OPCIONAIS:

Atualize ou adicione observações.

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.

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.

ADD TAGS TO LEAD:

Adiciona Tags a um determinado lead.

CAMPOS OBRIGATÓRIOS:

Lead ID: Identificador do lead a ser editado.
Tags: Tags a serem adicionadas.

COMO USAR:

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

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”.

CAMPOS OBRIGATÓRIOS:

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

COMO USAR:

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

REMOVE TAGS FROM LEAD:

Remove as tags escolhidas de determinado lead.

CAMPOS OBRIGATÓRIOS:

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

COMO USAR:

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

GET ALL LEADS:

Lista todos os leads cadastrados no sistema.

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.

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.