Referência / Webhooks

Excluir webhook

DELETE/api/v1/user/webhook/{user_id}/{webhook_type}/{webhook_id}

Remove apenas o webhook indicado pelo `webhook_id`. Se houver outro webhook do mesmo tipo, ele será preservado.

Ambiente

Autenticação Basic

Base64

Basic:

Esta requisição pode criar, alterar ou remover dados no ambiente selecionado.

cURL

Exemplo gerado

1curl --request DELETE \2  --url 'https://staging.sharktecnologia.com/api/v1/user/webhook/{user_id}/{webhook_type}/{webhook_id}' \3  --header 'accept: application/json' \4  --header 'Authorization: Basic BASE64(SUA_API_KEY:SEU_SECRET_KEY)'

Resposta

Clique em Executar para enviar a requisição e visualizar a resposta aqui.

Parâmetros de path

3 campos

user_idintegerObrigatório

ID do usuário dono do webhook.

webhook_typestring · enumObrigatório

Tipo do webhook.

Valores: pix_inpix_outaccount

webhook_idstring · uuidObrigatório

UUID do webhook.

Resposta

200WebhookDeleteResponse

Webhook excluído com sucesso.

JSON · Resposta de sucesso

{
  "detail": "Webhook 0b4f9c2b-1df5-4a2e-b4db-2e9bbd4f0a10 deleted successfully"
}

Campos da resposta

1 campo

detailstringObrigatório

Mensagem de confirmação da exclusão.

Status HTTP

200

Webhook excluído com sucesso.

400

Usuário não encontrado, webhook_id inexistente ou usuário com perfil Customer tentando acessar outro usuário.

401

Token Basic ausente ou inválido.