Skip to main content
Um webhook é um POST que a Legitimuz faz para um endpoint seu quando algo acontece numa verificação. É por ele que a decisão chega ao seu sistema.

Como funciona

1

Cadastre um endpoint

No dashboard, em Integrações → Segurança → Webhooks, com a URL e os eventos que você quer receber. O passo a passo está em cadastrar webhooks.
2

Receba o POST

Quando um evento acontece, a Legitimuz envia o corpo assinado para a sua URL.
3

Confira e responda

Valide a assinatura, responda 2xx e processe em segundo plano.

Os eventos

A maioria das integrações escuta um só: verification.decided. O corpo de cada evento está em eventos.

O que o seu endpoint precisa fazer

  • Responder 2xx assim que conferir a assinatura. Processar em fila.
  • Conferir X-Legitimuz-Signature sobre o corpo cru.
  • Descartar repetição pelo header X-Legitimuz-Delivery.
  • Tratar review como pendência, não como recusa.
  • Aceitar verification.decided duas vezes para a mesma verificação.
  • Registrar e responder 2xx para evento desconhecido.
Os detalhes estão em segurança.

Sandbox e produção

Um endpoint numa integração sandbox recebe os eventos das verificações sandbox. Formato, assinatura e retentativa são os mesmos da produção.

Próximos passos

Eventos

O corpo de cada um dos sete eventos.

Segurança

Assinatura, retentativa e idempotência.