Configurar API/Webhook

Aprenda a gerar o **Token da API** e a configurar a **URL do Webhook** (com opção de baixar um workflow para **n8n**) para integrar com outros sistemas.

codeIntegrações
labelAPI e Webhook
schoolintermediario
generated
schedule2026-10-01
notes

Para que serve

Use API e Webhook para integrar com plataformas externas.

- API: permite gerar e copiar um token para autenticar integrações.
- Webhook + n8n: permite informar uma URL do Webhook para receber eventos do Chat Inteligente em tempo real.

Também há um link de Documentação da API e a opção de Baixar workflow para usar no n8n.

notes

Resumo rápido

  • Selecione API para gerar ou regerar o Token da API e copiar.
  • Selecione Webhook + n8n para preencher a URL do Webhook.
  • Use Baixar workflow para baixar um arquivo pronto para importar no n8n.
  • Clique em Salvar Webhook para começar a enviar eventos.
  • Se aparecer erro de URL, corrija para HTTP ou HTTPS.

Resultado esperado: Integração pronta: Token da API disponível para copiar e URL do Webhook salva, com os eventos sendo enviados após salvar.

notes

Passeio guiado (o que aparece)

  • Central de integrações: Use a lista de aplicativos para selecionar uma integração e abrir as configurações.
    Cada item mostra um status como Ativa/Inativa.
  • Janela da integração: Ao abrir uma integração, aparece um título, o nome e um botão Fechar.
    No rodapé, aparece Integração ativa/inativa.
  • Integração API: Mostra Credenciais da API e o campo Token da API.
    Aparecem botões como Gerar Token, Regerar Token e Copiar.
    Também aparece o link Documentação da API.
  • Integração Webhook + n8n: Mostra o fluxo Chat Inteligente → Webhook → n8n / Seu sistema.
    Em Configurar Webhook, preencha URL do Webhook.
    Use Baixar workflow para baixar o arquivo.
    Clique em Salvar Webhook para ativar o envio.
notes

Termos que podem confundir

  • Webhook: Um link (URL) que recebe dados automaticamente quando um evento acontece.
    Aqui, os eventos do Chat Inteligente são enviados para a URL informada.
  • Token da API: Uma senha longa usada para autenticar integrações externas.
    Use Copiar para levar o token para outro sistema.
  • n8n: Uma ferramenta de automação.
    O botão Baixar workflow entrega um arquivo para importar no n8n.
  • URL de produção: No texto aparece: "No n8n, utilize a URL de produção do nó Webhook."
    Cole essa URL no campo URL do Webhook.
edit_note

Campos principais

URL do Webhook

edit_noteurl
Obrigatório

Descrição: Cole a URL que recebe os eventos.
Use o padrão mostrado no exemplo do campo.
Quando a URL fica salva, os eventos passam a ser enviados (conforme o aviso: "Os eventos serão enviados após salvar a URL.").

Regras/validações: - Precisa ser uma URL HTTP ou HTTPS válida.
- Mensagem que pode aparecer: "Informe uma URL HTTP ou HTTPS válida."

Exemplos: - https://seu-webhook.com/eventos
- http://seu-webhook.com/eventos

Token da API

edit_notetexto (somente leitura)
Opcional

Descrição: Use Gerar Token para criar.
Use Regerar Token para criar um novo.
Use Copiar para copiar o valor.

Regras/validações: Não aparecem regras de formato para digitação, porque o campo fica somente leitura.

Exemplos: - Gere um token e clique em Copiar.
- Se já existir token, use Regerar Token e depois Copiar.

format_list_numbered

Como configurar (passo a passo)

1

Abrir a integração certa

Selecione uma integração na lista.
Para Webhook, selecione Webhook + n8n.
Para token, selecione API.

2

Baixar o workflow do n8n (opcional)

Em Webhook + n8n, clique em Baixar workflow.
Se aparecer Gerando arquivo, aguarde terminar.

3

Preencher a URL do Webhook

Em Configurar Webhook, preencha URL do Webhook.
Use como referência o exemplo: https://seu-webhook.com/eventos.
Observe a dica: "No n8n, utilize a URL de produção do nó Webhook."

4

Salvar o Webhook

Clique em Salvar Webhook.
Aguarde o status Salvando terminar.
Leia o aviso: "Os eventos serão enviados após salvar a URL."

5

Gerar o Token da API

Na integração API, clique em Gerar Token.
Se já existir um token, use Regerar Token.

6

Copiar o Token da API

Com o token preenchido, clique em Copiar.
Procure a confirmação: "Token copiado para a área de transferência!"

7

Abrir a documentação da API (opcional)

Clique em Documentação da API para abrir o link em outra aba.

notes

Regras e comportamentos importantes

  • Preencha URL do Webhook com HTTP ou HTTPS; caso contrário, aparece "Informe uma URL HTTP ou HTTPS válida."
  • Se a URL ficar vazia ao salvar, pode aparecer alerta: "Favor inserir a Url do webhook!"
  • Ao salvar corretamente, aparece confirmação: "Dados do usuário salvo com sucesso!"
  • Os eventos começam a ser enviados após salvar a URL (conforme o aviso exibido).
  • Ao copiar o token, aparece confirmação: "Token copiado para a área de transferência!"
bug_report

Problemas comuns e como resolver

errorAparece: "Informe uma URL HTTP ou HTTPS válida."

Causa provável: URL do Webhook sem http/https ou com formato inválido.

Como corrigir: - Preencha começando por http:// ou https://.
- Compare com o exemplo do campo: https://seu-webhook.com/eventos.
- Clique em Salvar Webhook novamente.

Como confirmar: A mensagem de erro para de aparecer e o botão sai de Salvando sem erro visível.

errorAparece alerta: "Favor inserir a Url do webhook!"

Causa provável: Campo URL do Webhook está vazio.

Como corrigir: - Preencha o campo URL do Webhook.
- Clique em Salvar Webhook.

Como confirmar: O alerta não aparece e a URL fica informada (status pode mostrar URL informada).

errorAo clicar em "Baixar workflow", aparece: "Não foi possível baixar o workflow do n8n. Tente novamente."

Causa provável: Falha ao gerar o arquivo de download no momento.

Como corrigir: - Clique em Baixar workflow novamente.
- Se continuar, tente mais tarde.

Como confirmar: Aparece: "Workflow do n8n baixado com sucesso!"

errorAo clicar em "Copiar", aparece: "Falha ao copiar o token."

Causa provável: Cópia para a área de transferência falhou no navegador.

Como corrigir: - Tente clicar em Copiar novamente.
- Se continuar falhando, selecione o texto do token e copie manualmente (Ctrl+C / Cmd+C).

Como confirmar: Aparece: "Token copiado para a área de transferência!" ou o token fica colado corretamente no local de destino.

notes

O que muda depois de configurar

Alterações no sistema: - Ao clicar em Salvar Webhook, os eventos passam a ser enviados para a URL do Webhook (conforme a mensagem: "Os eventos serão enviados após salvar a URL.").
- Ao gerar o Token da API, fica disponível um token para autenticar integrações externas (conforme: "Gere e copie o token usado para autenticar suas integrações externas.").

  • n8n
  • API

Logs: Não aparece nenhum local de consulta de logs (registros) neste fluxo.