Registro de um novo webhook

Este endpoint permite criar uma configuração para definir quais notificações serão recebidas pelo Webhook do Banco Liquidante.

⚠️
Importante
Não é permitido criar webhooks cujo campo name seja igual ao valor de eventName.Caso essa ação seja tentada, a API responderá com o código de status 403 - UNAUTHORIZED_ACCESS.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

O parceiro possua a URI de seu endpoint.
O usuário possua uma conta de acesso ao backoffice, fornecida previamente pelo time de integrações.

📘
Nota
Para mais informações, confira a documentação Pré-requisitos para configuração.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/WebhookInternal/registerWebhook

--request POST 'https://sandbox.hiperbanco.com.br/WebhookInternal/registerWebhook' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "name": "NOME_DEFINIDO_PELO_USUARIO",
  "context": "Boleto",
  "uri": "https://hiperbancosandbox.com.br",
  "eventName": "BOLETO_CASH_IN_WAS_RECEIVED"
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Especificação
`name`	`string`	Obrigatório. Nome que o assinante deseja dar para identificar o evento. Esse nome é da escolha do parceiro. Exemplo: TED_CASH_IN.	Máximo de 50 caracteres.
`context`	`string`	Obrigatório. Nome do contexto do evento para o qual a configuração de webhook está sendo criada. Ele deve ser escrito exatamente conforme apresentamos na documentação de eventos.	—
`uri`	`string`	Obrigatório. URI da API fornecida pelo parceiro para o recebimento dos eventos. Exemplo: https://meuwebhook/123456	Formato https e máximo de 500 caracteres.
`eventName`	`string`	Obrigatório. Nome do evento que está sendo assinado. Ele deve ser escrito exatamente conforme apresentamos na documentação de eventos.	—

{
  "name": "NOME_DEFINIDO_PELO_USUARIO",
  "context": "Boleto",
  "uri": "https://hiperbancosandbox.com.br",
  "eventName": "BOLETO_CASH_IN_WAS_RECEIVED"
}

Resposta (Response)

O status code 201 indicará que a configuração do webhook foi criada com sucesso.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Número máximo de caracteres
`id`	`string`	Identificador da configuração de webhook.	—
`name`	`string`	Nome da configuração criada.	50
`context`	`string`	Nome do contexto do evento para o qual a configuração de webhook foi criada.	50
`eventName`	`string`	Nome do evento assinado.	150
`uri`	`string`	URI da API fornecida pelo parceiro para o recebimento dos eventos.	500
`publicKey`	`string`	Chave aleatória gerada pelo parceiro e que será enviada pelo Bankly nos cabeçalhos dos eventos de webhook.	60

{
    "id": "89444df2-a1d1-4fe8-ade8-3d03de0fd61m",
    "name": "SANDBOX_BOLETO_CASH_IN_WAS_RECEIVED",
    "context": "Boleto",
    "eventName": "BOLETO_CASH_IN_WAS_RECEIVED",
    "uri": "https://meuwebhook.com/123",
    "publicKey": "872dc2ed-8bee-40b5-8465-5d2953ba76dp"
}

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
`403`	`UNAUTHORIZED_ACCESS`	Cannot create webhook with name "BOLETO_CASH_IN_WAS_RECEIVED".	Não é possível criar webhook com nome
`409`	`WEBHOOK_CONFLICT`	This configuration already exists.	Essa configuração já existe.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.