Exclusão de configuração

Este endpoint permite realizar a exclusão de uma configuração de webhook.

⚠️
Importante
Não é permitido excluir 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 o id da configuração do webhook.
O usuário possua uma conta de acesso ao backoffice, fornecida previamente pelo time de integrações.

Requisição (Request)

Requisição HTTP

DELETE https://sandbox.hiperbanco.com.br/WebhookInternal/deleteWebhook/{id}

--request DELETE 'https://sandbox.hiperbanco.com.br/WebhookInternal/deleteWebhook/{id}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

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)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

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

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.