Por que configurar um webhook
Sem webhook, você precisa chamar GET /report/:id repetidamente até o relatório ficar pronto. Com webhook, a GYRA+ avisa você assim que o resultado estiver disponível, mais eficiente, mais confiável.
Pré-requisitos
- Token JWT válido (veja autenticação)
- Um endpoint HTTPS público e acessível que responda
HTTP 200
Passo 1, Crie seu endpoint
Seu servidor precisa de um endpoint que aceite POST e responda 200 rapidamente.
Nunca processe o payload de forma síncrona antes de responder 200. Se o seu servidor demorar para responder, a GYRA+ pode tentar reenviar.
Passo 2, Registre a URL
Resposta:
Passo 3, Teste o recebimento
Crie um relatório e monitore se o webhook chega:
Após 30–90 segundos (dependendo das integrações ativas), seu endpoint deve receber:
Passo 4, Receber a decisão do comitê
Se a sua política usa o Comitê de Crédito IA, registre também o tipo COMMITTEE_FINISHED. Cada webhook escuta um tipo, então é um registro separado:
O payload traz a decisão e a síntese do Presidente:
Se a política está em Não convocar automaticamente, o comitê só delibera depois que você chamar POST /report/{id}/committee. O gatilho natural é o próprio REPORT_FINISHED: quando ele chega, o relatório já está pronto para ir a comitê.
Os webhooks da organização são copiados para o relatório na criação dele. Registre COMMITTEE_FINISHED antes de criar os relatórios que vão a comitê, senão o evento não tem destino para os que já existiam.
Gerenciar webhooks
Listar webhooks cadastrados:
Remover um webhook:
Boas práticas