Skip to main content
Para manter o seu sistema atualizado de forma reativa, a Wincred envia requisições 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.
Se o seu endpoint ficar indisponível por mais de cerca de 30 minutos, as retentativas das notificações do período se esgotam. Depois de uma indisponibilidade, reconcilie o estado consultando o GET dos processos em andamento e avise o time de integrações.

Pelo menos uma vez, sem ordem garantida

  • A mesma notificação pode chegar mais de uma vez. Guarde os event_id já processados e ignore os repetidos, respondendo 2xx para eles.
  • Não há garantia de ordem entre notificações. Ordene por occurred_at e, para o estado atual, consulte o GET.

Origem das notificações

A Wincred não garante IP fixo de saída para os webhooks. Por isso, valide cada notificação pela assinatura, e não pelo IP de origem.