Integração via Webhooks de Saída
O Kazah permite que sua empresa receba notificações automáticas sempre que determinados eventos ocorrerem,
por meio de Webhooks de saída. Essa integração é ideal para sincronizar dados com outros sistemas,
automatizar fluxos e registrar movimentações em tempo real.
Como funciona
Um Webhook é basicamente uma chamada HTTP POST feita pelo Kazah para a URL informada por você
quando um determinado evento (gatilho) é acionado. O corpo da requisição contém um JSON com os dados do evento.
Requisitos:
- O endpoint deve aceitar requisições
POSTcomContent-Type: application/json; - Deve retornar
HTTP 200 OKem caso de sucesso; - O tempo máximo de resposta deve ser inferior a 10 segundos.
Cadastro do Webhook
Para configurar um Webhook, acesse o menu de Configurações -> Webhooks no Kazah e informe:
- URL de destino: endereço HTTP/HTTPS para onde o Kazah enviará os dados.
- Gatilho: evento que acionará o envio.

Gatilhos disponíveis
| Evento | Descrição | Modelo de Payload |
|---|---|---|
| Fechamento do Contrato | Disparado quando um contrato é fechado no Kazah. | Contrato |
| Criação do Orçamento | Disparado quando um novo orçamento é criado. | Orçamento |
| No Ato do Cadastro | Disparado quando um novo contato é cadastrado. | Contato |
| No Ato da Conversão | Disparado quando um contato é convertido em cliente. | Contato |
| Ao Inserir / Editar / Receber Contas a Receber | Notifica operações em contas a receber. | ContaReceber |
| Ao Inserir / Editar / Baixar Contas a Pagar | Notifica operações em contas a pagar. | ContaPagar |
Exemplo de Payload – Contrato
{
"Numero": 123,
"Versao": 123,
"TipoDocumento": 123,
"DataEvento": "2025-10-31T14:00:00Z",
"DataEmissao": "2025-10-31T14:00:00Z",
"HorarioInicial": null,
"HorarioFinal": null,
"StatusContratoId": 123,
"Pax": 123,
"Valor": 99.99,
"EventoId": 123
}
Exemplo de Payload – Orçamento
{
"ID": 123,
"ContatoId": 123,
"TipoEventoId": 123,
"DataEvento": "2025-10-31T14:00:00Z",
"HorarioInicial": null,
"HorarioFinal": null,
"Pax": 123,
"ModeloId": 123,
"Valor": 99.99,
"Desconto": 99.99,
"Observacoes": "Exemplo de Observacoes"
}
Exemplo de Payload – Contato
{
"Data": "2025-10-31T14:00:00Z",
"Nome": "Exemplo de Nome",
"Email": "Exemplo de Email",
"Celular": "Exemplo de Celular",
"TipoClienteId": 123,
"OrigemContatoId": 123,
"DataPretendidaInteresse": "2025-10-31T14:00:00Z",
"PaxInteresse": 123
}
Exemplo de Payload – Conta a Receber
{
"Parcela": 123,
"NumeroDocumento": "Exemplo de NumeroDocumento",
"ValorParcela": 99.99,
"ValorRecebimento": 99.99,
"Historico": "Exemplo de Historico",
"DataVencimento": "2025-10-31T14:00:00Z",
"DataRecebimento": "2025-10-31T14:00:00Z",
"ContatoId": 123,
"FormaPagamentoId": 123,
"PlanoContaId": 123
}
Exemplo de Payload – Conta a Pagar
{
"Parcela": 123,
"NumeroDocumento": "Exemplo de NumeroDocumento",
"ValorParcela": 99.99,
"ValorPagamento": 99.99,
"DataVencimento": "2025-10-31T14:00:00Z",
"DataPagamento": "2025-10-31T14:00:00Z",
"FornecedorId": 123,
"FormaPagamentoId": 123,
"CentroCustoId": 123
}
Exemplo de Resposta Esperada
HTTP/1.1 200 OK
Content-Type: application/json
{
"success": true
}
Dicas importantes
- O Kazah registra cada tentativa de envio, incluindo resposta HTTP e conteúdo retornado.
- Em caso de erro (timeout ou status diferente de 2xx), novas tentativas não são reexecutadas automaticamente.
- É recomendável validar o campo
IDrecebido, caso existam reenvios manuais.