Webhook - Guia de Integração

🚧

Essa é a primeira versão do Webhook e sua documentação. Alterações/melhorias que mudem seu comportamento podem ocorrer no futuro.

O intuito principal da plataforma de webhooks da Creditas é melhorar a experiência para o cliente final, que poderá ser informado no momento em que houver andamento da sua proposta.

A implementação do webhook para envio de eventos da esteira visa, além de melhorar a maturidade da integração entre a plataforma da Creditas e dos parceiros, eliminar o polling que hoje é feito aos endpoints:

• /proposals/:proposalId/status
• /proposals/:proposalId/conditions/credit-approved
• /proposals/:proposalId/conditions/payment-approved

Implementação

1. Solicitar ao seu consultor o registro no nosso serviço de webhook da @Creditas B2B-API. Nesta solicitação, você deverá nos informar:

• Dentre os eventos que disponibilizamos, em quais deseja se inscrever.
  Você poderá utilizar: um endpoint por evento ou, se preferir, um único endpoint para todos os eventos (desde que este interprete as mensagens de diferentes eventos do webhook corretamente). Saiba mais na sessão “Eventos ”.
• O seu endpoint em que irá receber os [POST] de cada uma de nossas notificações.
  Por segurança, ele precisará utilizar o protocolo https com SSL ou TLS válidos.

2. Solicitar a homologação em ambiente de homologação, você deverá nos informar:

• O seu endpoint em que irá receber os [POST] de cada uma de nossas notificações para homologação (pode ser o mesmo de produção).
  Por segurança, ele precisará utilizar o protocolo https com SSL ou TLS válidos.
  3. Solicitar a geração da credencial de produção.

⚠️

Você pode optar por se inscrever nos eventos livremente (em um, em dois, em três, … ou mesmo em todos), só precisamos que nos informem o(s) evento(s) desejado(s) e a(s) url correspondente(s) em que devemos notificar esse(s) evento(s)

⚠️

Nossos eventos são enviados usando o protocolo/método HTTP/POST

📘

Caso você tenha alguma dúvida técnica sobre o processo de integração, envie um e-mail para:
[email protected]

Exemplo:

• PROCESSED → POST https://your-domain/proposal/processed
• CREDIT_ANALYSED → POST https://your-domain/proposal/credit_analysed

Estrutura geral dos eventos

Todos os eventos enviados seguirão o mesmo padrão estrutural de mensagem (payload) para dar flexibilidade ao parceiro que estiver integrando, de modo que possa informar endpoints diferentes ou o mesmo para determinados eventos.

{
  "id": "String",
  "name": "String",
  "data": "Object{}"
}