Webhooks

Visão Geral

Este Webhook permite a integração com o Kazah para o envio de informações de leads em tempo real. Ele recebe dados por meio de uma requisição HTTP POST e processa as informações para armazenamento e análise.

URL do Webhook

POST https://api.kazah.io/webhooks/lead/{TOKEN}

Onde {TOKEN} deve ser substituído pelo token público do usuário, que pode ser acessado nas configurações no Kazah.

Headers Requeridos

A requisição deve incluir o seguinte cabeçalho:

Content-Type: application/json

Corpo da Requisição (Payload)

O corpo da requisição deve estar no formato JSON com os seguintes campos:

{
  "nome": "string",
  "email": "string",
  "celular": "string",
  "pax": "string",
  "dataevento": "string",
  "tipoevento": "string",
  "conversao": "string",
  "origem": "string",
  "atendimento": "string",
}

Descrição dos Parâmetros

Campo	Tipo	Obrigatório	Descrição
nome	string	Sim	Nome do lead
email	string	Sim	Endereço de e-mail do lead
celular	string	Sim	Número de telefone do lead
pax	string	Sim	Quantidade de participantes no evento
dataevento	string	Sim	Data do evento no formato DD-MM-YYYY
tipoevento	string	Sim	Tipo de evento (exemplo: casamento, aniversário, etc.)
conversao	string	Sim	Status de conversão do lead
origem	string	Sim	Origem do lead (exemplo: Facebook, Instagram, Google, etc.)
atendimento	string	Não	E-mail vinculado ao atendimento (usuário Kazah). O preenchimento deste campo garante que tanto o lead quanto a oportunidade gerados sejam vinculados ao respectivo usuário de atendimento.

Exemplo de Requisição

Usando cURL

curl -X POST "https://api.kazah.io/webhooks/lead/{TOKEN}" \
     -H "Content-Type: application/json" \
     -d '{
         "nome": "João da Silva",
         "email": "joao@email.com",
         "celular": "+5511987654321",
         "pax": "100",
         "dataevento": "15/10/2025",
         "tipoevento": "Casamento",
         "conversao": "Interessado",
         "origem": "Facebook",
         "atendimento": "usuario@email.com.br" }'

Usando JavaScript (Fetch API)

fetch("https://api.kazah.io/webhooks/lead/{TOKEN}", {
    method: "POST",
    headers: {
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "nome": "João da Silva",
        "email": "joao@email.com",
        "celular": "+5511987654321",
        "pax": "100",
        "dataevento": "15/10/2025", 
        "tipoevento": "Casamento", 
        "conversao": "Interessado", 
        "origem": "Facebook", 
        "atendimento": "usuario@email.com.br" }) }).then(response => response.json()) .then(data => console.log(data)) .catch(error => console.error("Erro:", error)); 

Usando Postman

Para testar a requisição no Postman, siga os passos abaixo:

1. Abra o Postman e clique em New Request.
2. Selecione o método POST e insira a URL https://api.kazah.io/webhooks/lead/{TOKEN}.
3. Vá para a aba Headers e adicione:
   • Key: Content-Type
   • Value: application/json
4. Vá para a aba Body, selecione a opção raw e insira o seguinte JSON:

{
  "nome": "João da Silva",
  "email": "joao@email.com",
  "celular": "+5511987654321",
  "pax": "100",
  "dataevento": "15/10/2025", 
  "tipoevento": "Casamento", 
  "conversao": "Interessado", 
  "origem": "Facebook", 
  "atendimento": "usuario@email.com.br" 
} 

5. Clique em Send para enviar a requisição e verificar a resposta da API.

Respostas da API

Sucesso

Se a requisição for bem-sucedida, a API retornará um status 200 OK com uma resposta JSON semelhante a:

{
  "status": "sucesso",
  "mensagem": "Lead recebido com sucesso."
}

Erros Comuns

Código HTTP	Mensagem	Causa
400	Requisição Inválida	Algum campo está ausente ou mal formatado
401	Token Inválido	O token informado é inválido ou inexistente
500	Erro Interno	Ocorreu um erro inesperado no servidor

Considerações Finais

• Certifique-se de que o TOKEN seja mantido seguro e não exposto publicamente.
• Todos os campos são obrigatórios para garantir um processamento correto dos leads.
• O formato da data do evento deve seguir DD-MM-YYYY para evitar erros de interpretação.

Caso tenha dúvidas, entre em contato com o nosso suporte.