Formato de chamada do Webhook

📤 Payload do webhook

Quando um evento configurado ocorre, o sistema irá enviar uma requisição para a URL configurada no webhook com o seguinte formato de payload:

🔽 Estrutura do payload

Campo	Tipo	Descrição
id	string (guid)	Identificador único do webhook
sistemaOrigem	string?	Sistema que originou o evento
numeroProposta	number?	Número da proposta relacionada ao evento
nomeCliente	string?	Nome do cliente associado à proposta
cpfCliente	string?	CPF do cliente associado à proposta
clientId	string?	Id do sistema que originou o evento
evento	string?	Nome do evento que gerou a notificação
erros	string[]?	Lista de erros, se houver

📝 Formato JSON

O payload é enviado no formato JSON, conforme exemplo abaixo:

{
  "id": "b1e7f7e2-7e6e-4b8c-9e2e-123456789abc",
  "numeroProposta": 123456,
  "evento": "PROPOSTA_CRIADA",
  "erros": null
}

📌 Observações importantes

• Alguns campos são ignorados na serialização JSON e não são enviados no payload (marcados com [JsonIgnore]), são eles:

  • SistemaOrigem
  • NomeCliente
  • CpfCliente

• O campo Evento pode conter um dos seguintes valores, dependendo do evento ocorrido:

  • PROPOSTA_CRIADA
  • PROPOSTA_NAO_CRIADA
  • PROPOSTA_ALTERADA
  • PROPOSTA_NAO_ALTERADA
  • PROPOSTA_CANCELADA
  • PROPOSTA_NAO_CANCELADA
  • AVALIACAO_SAUDE_APROVADA
  • AVALIACAO_SAUDE_AGUARDANDO_APROVACAO
  • AVALIACAO_SAUDE_ARQUIVADA
  • AVALIACAO_SAUDE_DESARQUIVADA

🔄 Exemplos de Payload por Evento

Proposta criada

{
  "id": "b1e7f7e2-7e6e-4b8c-9e2e-123456789abc",
  "numeroProposta": 123456,
  "evento": "PROPOSTA_CRIADA",
  "erros": null
}

Avaliação de saúde aprovada

{
  "id": "c2f8e8f3-8f7f-5c9d-0f3f-234567890bcd",
  "numeroProposta": 123456,
  "evento": "AvaliacaoSaudeAprovada",
  "erros": null
}

Evento com erros

{
  "id": "d3g9f9g4-9g8g-6d0e-1g4g-345678901def",
  "numeroProposta": 123456,
  "evento": "PropostaNaoCriada",
  "erros": [
    "Documento inválido",
    "Endereço incompleto"
  ]
}

✅ Códigos de status esperados

O sistema espera que o endpoint do webhook retorne um código de status HTTP na faixa 2xx para considerar a entrega como bem-sucedida. Caso contrário, tentará reenviar o webhook conforme política de retry configurada.