API Parceiros - Webhook
Webhook – Visão Geral
O Webhook permite que o parceiro receba, de forma automática e passiva, todas as mudanças de status relacionadas à proposta. Com isso, elimina-se a necessidade de realizar consultas constantes à rota GET /ConsultarProposta, reduzindo tráfego, latência e custos operacionais.
Sempre que houver qualquer atualização relevante — aprovação, pendência, negativa, reanálise ou qualquer transição de status — o sistema enviará uma notificação imediatamente para o endpoint configurado pelo parceiro.
Como configurar o Webhook
O Webhook é configurado no momento do cadastro da proposta, utilizando a rota:
No body da requisição deve ser informado o campo:
-
urlNotificacaoParceiro: string
URL válida e acessível publicamente, que será utilizada como destino das notificações de Webhook.
Importante: certifique-se de que o endpoint esteja apto a receber requisições HTTP POST, com tempo de resposta adequado e retorno de status 200 para confirmações de recebimento.
{
"cpf": "435.901.808-89",
"nome": "Júlio Rossato",
"ocupacaoId": 1,
"cidadeId": "1762",
"logradouro": "Rua Rui Barbosa",
"bairro": "Limoeiro",
"cep": "63030000",
"urlNotificacaoParceiro": "null", // Inserir aqui o WEBHOOK
"nascimento": "1974-07-10",
"telefone": "44999167734"
}Eventualidades enviadas pelo Webhook
Após configurado, o parceiro passará a receber callbacks contendo qualquer movimento no ciclo de vida da proposta, incluindo — mas não limitado a:
-
Alterações de status
-
Pendências documentais
-
Retornos de análise
-
Aprovação ou negativa
-
Atualizações internas relevantes ao fluxo de crédito
O exemplo a seguir ilustram um payloads enviado pelo Webhook.
{
"propostaId": 123456,
"situacaoDescricao": "Proposta Pendente",
"login": "treinamento",
"observacoes": "Observação realizada ao pendenciar a proposta",
"motivos": [
"Contato Pendente",
"Valores não estão certo",
"Cliente não atendeu"
]
}