Alteração de configuração

Este endpoint permite alterar a URI do endpoint de um webhook configurado pelo parceiro.

⚠️
Importante
Não é permitido alterar 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.

Requisição (Request)

Requisição HTTP

PATCH https://sandbox.hiperbanco.com.br/WebhookInternal/changeWebhook/{id}

--request PATCH 'https://sandbox.hiperbanco.com.br/WebhookInternal/changeWebhook/{id}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "uri": "https://meuwebhook.com/webhook"
}'

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)

Nome	Tipo	Descrição
`id`	`path`	Obrigatório. id do webhook, que pode ser obtido na consulta de todas as configurações de webhooks.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Especificação
`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.

{
  "uri": "https://hiperbancosandbox.com.br"
}

Resposta (Response)

O status code 200 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 Banco Liquidante 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
`404`	`WEBHOOK_NOT_FOUND`	Webhook not found	Webhook não encontrado

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.