POST (webhooks) para a URL que você cadastrou a cada etapa da indicação que você assinou. Você implementa e mantém o endpoint; a Wincred assina cada envio para que você possa verificar a origem.
Cadastro
O cadastro é feito com o time de integrações, durante o onboarding, e não pela API. Você informa a URL HTTPS, a forma de autenticação (apenas a assinatura, ou a assinatura combinada com um header seu) e os eventos que quer receber. A Wincred gera o segredo da assinatura e o entrega a você. Veja Como integrar.Eventos
Formato
Por privacidade, nenhuma notificação traz dado pessoal do cliente.
Resposta e retentativas
Recomendamos validar a assinatura, persistir o evento em uma fila para processamento assíncrono e retornar 2xx imediatamente. Assim, o processamento mais demorado do seu lado não compete com o prazo de resposta do webhook.
Pelo menos uma vez, sem ordem garantida
- A mesma notificação pode chegar mais de uma vez. Guarde os
event_idjá processados e ignore os repetidos, respondendo 2xx para eles. - Não há garantia de ordem entre notificações. Ordene por
occurred_ate, para o estado atual, consulte oGET.