v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Configuração Webhook

Cadastro de webhook por evento

Adiciona uma nova configuração de webhook para notificação por tipo de evento.

post/pj/apibanking/forintegration/v1/boletos-hibridos/webhook

Request body

urlstring nullable
quantidadeRetentativasinteger
tipoEvento'BoletoHibridoErroValidacao' | 'BoletoHibridoEmitido' | 'BoletoHibridoRegistrado' | 'BoletoHibridoFalhaCancelamento' | 'BoletoHibridoCancelado' | 'BoletoHibridoLiquidado' | 'BoletoHibridoFalhaLiquidacao' | 'BoletoHibridoDevolucaoEfetivada' | 'BoletoHibridoDevolucaoRejeitada'
intervaloEntreRetentativasinteger

Example request

{
  "url": "https://webhook.site/1665163c-f292-4f03-9bbf-98d9fae03e22",
  "quantidadeRetentativas": 5,
  "intervaloEntreRetentativas": 1000,
  "usuarioCriacao": {
    "nome": "Nome do usuário",
    "email": "usuario@bs2tecnologia.com.br",
    "identificador": "bsiXXX"
  },
  "autenticacao": {
    "valor": "dXN1YXJpbzpzZW5oYQ=="
  }
}

Response

Created

string uuid required