Configurar API/Webhook

Aprenda a configurar o Webhook, gerar o Token da API e conectar integrações como agenda e formulários, de um jeito simples.

codeIntegrações
labelAPI e Webhook
schooliniciante
generated
schedule2025-12-18
notes

O que é e para que serve

Use Webhook para enviar dados automaticamente quando algo acontece.
O texto de ajuda informa que, com o Webhook, todos os dados das conversas são enviados para o sistema receptor.
Use API para ter uma chave (Token) e acessar a Documentação da API.
Também existem botões para vincular/desvincular integrações (ex.: agenda, planilha, leads e áudio).

notes

Resumo rápido

  • Cole uma URL de Webhook (começa com http:// ou https://).
  • Clique em Salvar no bloco de Webhook.
  • Em Token da API, clique em Gerar Token (ou Regerar Token).
  • Clique em Copiar para copiar o token.
  • Use Documentacao da API para abrir a documentação em outra aba.
  • Se precisar, use Vincular / Desvincular nas integrações (Calendly, Google, Facebook, ElevenLabs).

Resultado esperado: Webhook salvo e pronto para receber os dados enviados automaticamente.
Token da API disponível para copiar e usar.
Integrações opcionais vinculadas (quando configuradas).

format_list_numbered

Como configurar (passo a passo)

1

Preencher a URL do Webhook

No campo Webhook, cole a URL.
Use uma URL completa, por exemplo começando com https://.

2

Salvar o Webhook

Clique em Salvar.
Se aparecer Salvando, aguarde terminar.

3

Gerar o Token da API

No bloco API, localize o campo Token da API.
Clique em Gerar Token.
Se já existir um token e for necessário trocar, clique em Regerar Token.

4

Copiar o Token da API

Depois de gerar, clique em Copiar.
Use o token copiado onde for necessário.

5

Abrir a Documentação da API

Clique em Documentacao da API.
O link abre em outra aba.

6

Conectar integrações (opcional)

Para cada integração disponível, clique em Vincular com a conta....
Para parar uma integração, clique em Desvincular (ou Removendo... e aguarde).

edit_note

Campos que aparecem para preencher

Webhook

edit_notetexto
Obrigatório

Descrição: Cole a URL do webhook do sistema que vai receber os dados.
Este campo serve para permitir que o envio aconteça automaticamente quando ocorrer um evento.

Regras/validações: - Se ficar vazio, aparece a mensagem: "Favor inserir a Url do webhook!"
- Se a URL não for válida, aparece: "Favor inserir uma Url válida!"
- A URL precisa começar com http:// ou https://.

Exemplos: - https://meusite.com.br/webhook
- https://api.exemplo.com/hooks/receber

Token da API

edit_notetexto (somente leitura)
Opcional

Descrição: Mostra o token para uso com a API.
Use os botões Gerar Token, Regerar Token e Copiar.

Regras/validações: O campo aparece como somente leitura (não dá para digitar nele).

Exemplos: - Clique em Gerar Token para preencher automaticamente.
- Clique em Copiar para copiar o token.

Tempo duração dos eventos:

edit_notenúmero
Opcional

Descrição: Define o tempo padrão dos eventos criados na agenda.
Ao lado do campo aparece Minuto ou Minutos, conforme o valor.

Regras/validações: - Valor mínimo visível: 15.

Exemplos: - 15
- 30

Disponibilidade da Agenda:

edit_noteseleção

Valor padrão: Horario Comercial de Segunda a sexta

Opcional

Descrição: Escolha como considerar a disponibilidade da agenda para agendamentos.

Regras/validações: Opções visíveis:
- Horario Comercial de Segunda a sexta
- Todos horários disponíveis na agenda

Exemplos: - Horario Comercial de Segunda a sexta
- Todos horários disponíveis na agenda

Base de Conhecimento para Agendamentos:

edit_notetexto longo
Opcional

Descrição: Use este campo para orientar o agendamento.
O texto de ajuda diz para escrever requisitos, documentos obrigatórios, etapas de validação e outras regras.
Também informa que a Base de Conhecimento padrão não será consultada durante o agendamento.

Regras/validações: Não há limite de tamanho visível.
O campo mostra um exemplo no texto de ajuda.

Exemplos: - "Não solicitamos e-mail durante o agendamento. Utilize sempre o padrão email@email.com.br caso necessário."
- "Solicite obrigatoriamente os dados do plano de saúde antes de concluir o agendamento."

Disparar mensagens

edit_noteseleção

Valor padrão: Selecione…

Opcional

Descrição: Define um canal para disparar a mensagem inicial para o novo Lead.
O texto de ajuda diz: "Defina um canal a ser utilizado para disparar a mensagem inicial para o novo Lead."

Regras/validações: A lista começa com a opção Selecione….

Exemplos: - Selecione…
- (Escolha um canal disponível na lista)

Mensagem de boas vindas

edit_notetexto longo

Valor padrão: Olá! Recebemos suas informações através do formulário e é um prazer ter você por aqui.

Opcional

Descrição: Configura a mensagem automática enviada para novos leads capturados por formulários.

Regras/validações: Não há limite de tamanho visível.

Exemplos: - "Olá! Recebemos suas informações através do formulário e é um prazer ter você por aqui."
- "Oi! Obrigado por preencher o formulário. Quer falar com um atendente?"

API Key

edit_notetexto
Opcional

Descrição: Use para conectar a conta ElevenLabs TTS.
O texto de ajuda orienta criar a chave em: https://elevenlabs.io/app/settings/api-keys

Regras/validações: Ao salvar a integração do ElevenLabs, pode aparecer a mensagem: "Preencha API Key e Voice ID."

Exemplos: - (Cole a chave criada no site do ElevenLabs)
- (Se já existir e aparecer mascarada com asteriscos, troque apenas se necessário)

Voice ID

edit_notetexto
Opcional

Descrição: Identifica qual voz usar no ElevenLabs TTS.
O texto de ajuda orienta copiar o Voice ID em: https://elevenlabs.io/app/voice-lab

Regras/validações: Ao salvar a integração do ElevenLabs, pode aparecer a mensagem: "Preencha API Key e Voice ID."

Exemplos: - (Cole o Voice ID copiado do Voice Lab)
- (Exemplo de preenchimento: um código/ID colado do ElevenLabs)

notes

Regras e cuidados importantes

  • Preencha o Webhook com uma URL que começa com http:// ou https://.
  • Se o Webhook ficar vazio, aparece "Favor inserir a Url do webhook!".
  • Se o Webhook tiver formato errado, aparece "Favor inserir uma Url válida!".
  • Em Tempo duração dos eventos, o mínimo visível é 15.
  • Em integrações, quando aparecer Salvando, Removendo... ou Testando, aguarde finalizar antes de clicar de novo.
  • Em Token da API, use Gerar Token / Regerar Token e depois Copiar.
bug_report

Problemas comuns e como resolver

error

Aparece "Favor inserir a Url do webhook!" ao salvar

Causa provável: O campo Webhook está vazio.

Como corrigir: Preencha o campo Webhook com a URL completa.
Depois clique em Salvar novamente.

Como confirmar: O aviso não aparece e o botão deixa de mostrar Salvando após concluir.

error

Aparece "Favor inserir uma Url válida!"

Causa provável: A URL do Webhook não está no formato esperado (por exemplo, sem http/https).

Como corrigir: Confira se a URL começa com http:// ou https://.
Cole a URL novamente e clique em Salvar.

Como confirmar: O sistema aceita salvar sem mostrar o alerta de URL inválida.

error

Ao copiar o token, aparece "Falha ao copiar o token."

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

Como corrigir: Tente clicar em Copiar novamente.
Se estiver usando janela restrita (ex.: bloqueios do navegador), tente copiar em outra tentativa.

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

error

Ao salvar o ElevenLabs, aparece "Preencha API Key e Voice ID."

Causa provável: Um dos campos (API Key ou Voice ID) está vazio.

Como corrigir: Preencha API Key e Voice ID.
Depois clique em Salvar.

Como confirmar: Aparece a mensagem "Integração salva com sucesso!".

error

Ao conectar Google Sheets, aparece "Falha ao gerar URL do Sheets."

Causa provável: A tentativa de iniciar a conexão não concluiu como esperado.

Como corrigir: Tente clicar novamente em Vincular com a conta Google.
Se continuar, tente mais tarde.

Como confirmar: Abre a etapa de login/conexão do Google em seguida.

notes

Receitas rápidas (situações comuns)

  • Usar Webhook para receber dados automaticamente: 1) Cole a URL no campo Webhook.
    2) Clique em Salvar.

    Resultado: o webhook fica configurado para envio automático de dados quando ocorrer um evento.
  • Gerar e copiar o Token da API: 1) No bloco API, clique em Gerar Token.
    2) Clique em Copiar.
    3) (Opcional) Clique em Documentacao da API para consultar a documentação.

    Resultado: token pronto para uso e copiado.
  • Conectar e desconectar Calendly: 1) Clique em Vincular com a conta Calendly.
    2) Para parar depois, clique em Desvincular.

    Resultado: agenda sincroniza automaticamente quando estiver Ativo.
  • Conectar Facebook Leads e mandar mensagem de boas-vindas: 1) Clique em Vincular com a conta Facebook.
    2) Em Disparar mensagens, selecione um canal.
    3) Em Mensagem de boas vindas, escreva a mensagem.
    4) Clique em Salvar.

    Resultado: leads entram automaticamente e recebem a mensagem configurada.
notes

O que muda quando configurar

Alterações no sistema: - O texto de ajuda informa que o Webhook permite integrar com plataformas externas e que todos os dados das conversas são enviados para o sistema receptor.
- Ao conectar Calendly ou Google Agenda, o sistema pode sincronizar a agenda e automatizar ações como agendar, remarcar ou cancelar compromissos (conforme descrito nos textos de ajuda).
- Ao conectar Google Sheets, os dados dos contatos das conversas ficam sendo registrados; o texto informa atualização a cada 2 horas.
- Ao conectar Facebook Leads, novos leads são capturados automaticamente e pode ser enviada uma mensagem personalizada.
- Ao conectar ElevenLabs TTS, os áudios passam a seguir as configurações da conta ElevenLabs (como descrito no texto).

  • Webhook
  • API
  • Calendly
  • Google Agenda
  • Google Sheets
  • Facebook Leads
  • ElevenLabs TTS

Logs: Não há indicação visível de onde consultar registros (logs) nesta funcionalidade.