Ir para o conteúdo principal
Contrato OpenAPI v0.1.0: Alinhado ao arquivo contracts/openapi.yaml. Endpoints exclusivos do Console (/dashboard/v1) aguardam publicação complementar do backend.

Webhooks

Configure endpoints HTTPS no console para receber eventos assíncronos da sua organização sem precisar consultar a API em loop.

Eventos planejados

  • comparison.completed — Comparação concluída.
  • billing.low_balance — Saldo atingiu o limiar de alerta configurado.
  • billing.recharge.confirmed — Recarga Pix confirmada no saldo.
  • apikey.revoked — Uma API key da organização foi revogada.

Validação de assinatura

Toda entrega inclui um header de assinatura HMAC-SHA256 gerado com o segredo do seu endpoint de webhook. Valide sempre o HMAC utilizando comparação em tempo constante antes de processar o payload e responda com HTTP 2xx em até 5 segundos.