webhook

Criar webhook para notificacoes

Registra uma URL que recebe um POST a cada evento do tipo escolhido. Cada webhook escuta um tipo; para varios tipos, cadastre varios webhooks.

Antes de salvar, a GYRA+ faz um POST de teste na URL com o corpo {"message": "Teste de webhook cadastrado com sucesso!"}. Se a URL nao responder 2xx, o cadastro e recusado com 400 "URL de webhook inválida.".

Tipos:

  • REPORT: cada secao do relatorio atualizada (varios disparos por relatorio)
  • REPORT_FINISHED: todas as fontes do relatorio terminaram
  • REPORT_STATUS: decisao gravada no relatorio (manual ou automatica)
  • CREDIT_POLICY: o resultado da politica de credito mudou de status
  • REPORT_EXPORTED: arquivo exportado pronto (ou falha da exportacao)
  • COMMITTEE_FINISHED: o Comite de Credito IA concluiu ou falhou
  • OPERATION: execucao de esteira concluiu com status final
  • OPTIN: fluxo de opt-in

Envelope de todo evento: { organizationId, webhookType, data }. Se apiKey for informada, vai no header api-key. Entrega com falha de rede, 5xx, 408, 425 ou 429 e tentada de novo ate 3 vezes.

REPORT, REPORT_FINISHED e COMMITTEE_FINISHED so saem para relatorios criados depois do cadastro do webhook.

post/webhook

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/webhook
  • Auth: none declared

Request body

type'REPORT' | 'OPTIN' | 'CREDIT_POLICY' | 'REPORT_STATUS' | 'REPORT_FINISHED' | 'REPORT_EXPORTED' | 'COMMITTEE_FINISHED' | 'OPERATION' required

Type Webhook

urlstring required

The URL for the webhook

apiKeystring

API Key para uma requisição autenticada (será enviado como api-key em headers)

Example request

{
  "url": "https://webhook-test.com/a0a7aadb8de3e",
  "apiKey": "xxx-xxx-xxx"
}

Response

Webhook criado com id, type, url e organizationId.

idstring
typestring
urlstring
apiKeystring nullable
organizationIdstring
createdAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.