Configurar API/Webhook

Define o link de Webhook para enviar dados das conversas para outro sistema e gera/consulta o Token da API para integração.

codeIntegrações
labelAPI e Webhook
schooliniciante
generated
schedule2026-07-09
notes

Para que serve

Use Webhook para enviar automaticamente os dados das conversas para um sistema externo.
Use API para ver e testar as APIs do sistema com uma documentação interativa.
Quando precisar, gere um Token da API e copie para usar na integração.
Para aprender mais, use os botões de ajuda API e Webhook e Wiki.

notes

Em poucas palavras

  • Abra Documentacao da API para ver e testar as APIs no navegador.
  • Em Token da API, clique em Gerar Token (ou Regerar Token) quando precisar.
  • Clique em Copiar para copiar o token.
  • Em Webhook, cole a Url do webhook.
  • Clique em Salvar para gravar.

Resultado esperado: O Token da API fica disponível para copiar, e o Webhook fica salvo para envio automático de dados das conversas.

notes

O que aparece e onde clicar

  • Ajuda (Wiki e vídeo): Use API e Webhook em Como funciona para assistir ao vídeo de ajuda.
    Use Wiki em Como integrar para abrir Como integrar.
  • API: Use Documentacao da API para abrir Documentacao da API em outra aba.
    Confira Token da API e use os botões:
    - Gerar Token (quando o token ainda não existe)
    - Regerar Token (quando já existe)
    - Copiar (quando já existe)
  • Webhook: Preencha o campo Webhook com a URL do webhook.
    Clique em Salvar para gravar.
    Enquanto salva, o botão pode mostrar Salvando.
edit_note

Campos principais

Token da API

edit_notetexto (somente leitura)
Opcional

Descrição: Use este campo para ver o token gerado.
Para criar um token, clique em Gerar Token.
Para trocar o token, clique em Regerar Token.
Para levar o token para outro lugar, clique em Copiar.

Regras/validações: Não aparece como campo para digitar (é readonly).
Ao copiar, pode aparecer:
- Token copiado para a área de transferência!
- Falha ao copiar o token.

Exemplos: - Ação: clicar em Gerar Token e depois em Copiar.
- Ação: clicar em Regerar Token (confirmar) para gerar um novo.

Webhook

edit_notetexto (URL)
Obrigatório

Descrição: Cole aqui o link (URL) do webhook do sistema que recebe os dados.
Depois, clique em Salvar para gravar.

Regras/validações: Se ficar vazio, aparece: Favor inserir a Url do webhook!
Se estiver no formato errado, aparece: Favor inserir uma Url válida!

Exemplos: - https://exemplo.com/webhook
- https://minhaempresa.com.br/integracao/webhook

format_list_numbered

Como configurar

1

Abrir a documentação da API (opcional)

Clique em Documentacao da API para abrir a documentação interativa em outra aba.

2

Gerar o token da API (quando necessário)

Em Token da API, clique em Gerar Token.
Se já existir token e precisar trocar, clique em Regerar Token e confirme quando aparecer a pergunta.

3

Copiar o token da API

Clique em Copiar para copiar o conteúdo de Token da API.
Confirme pela mensagem Token copiado para a área de transferência!.

4

Preencher o Webhook

Em Webhook, cole a URL no campo com o placeholder Insira a Url do webhook.

5

Salvar

Clique em Salvar.
Aguarde o botão mostrar Salvando e finalizar.
Confirme pela mensagem Dados do usuário salvo com sucesso! (quando aparecer).

notes

Regras e comportamentos importantes

  • Para salvar, o campo Webhook não pode ficar vazio.
  • Se o link do Webhook não estiver em um formato aceito, aparece Favor inserir uma Url válida!.
  • Ao clicar em Regerar Token, aparece a confirmação Tem certeza que deseja gerar um novo token?.
  • Durante o salvamento, os botões podem ficar desativados e mostrar Salvando / Salvando....
  • O botão Copiar só aparece quando existe um Token da API.
bug_report

Erros comuns e como resolver

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

Causa provável: O campo Webhook ficou vazio.

Como corrigir: Cole uma URL no campo Webhook e clique em Salvar novamente.

Como confirmar: A mensagem de erro não aparece e o salvamento finaliza (pode aparecer Dados do usuário salvo com sucesso!).

errorAparece a mensagem: "Favor inserir uma Url válida!"

Causa provável: O valor colado em Webhook não está em um formato de URL aceito.

Como corrigir: Revise o link colado.
Cole a URL completa no campo Webhook e clique em Salvar.

Como confirmar: Ao clicar em Salvar, a mensagem de URL inválida não aparece.

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

Causa provável: A cópia para a área de transferência não funcionou no momento.

Como corrigir: Tente clicar em Copiar novamente.
Se estiver usando uma janela com restrições, tente em outra aba/janela do navegador.

Como confirmar: Aparece a mensagem Token copiado para a área de transferência!.

errorO botão mostra "Salvando" e demora

Causa provável: O salvamento ainda está em andamento.

Como corrigir: Aguarde a finalização.
Evite clicar várias vezes no botão.

Como confirmar: O botão volta ao normal (por exemplo, Salvar) e/ou aparece uma mensagem de sucesso.

notes

O que muda depois de configurar

Alterações no sistema: Ao preencher e salvar o Webhook, os dados das conversas são enviados para o sistema receptor, permitindo integração personalizada.
Ao gerar um Token da API, o valor fica disponível no campo Token da API e pode ser copiado para uso em integrações.

  • Webhook (envio automático de dados via HTTP)
  • API (documentação interativa em Documentacao da API)

Logs: Não há informações visíveis aqui sobre registros (logs) ou histórico de envios.