Webhooks

Apagar Webhook

Remove o webhook e cancela entregas pendentes

DELETE

/v1/webhooks/{id}

Escopo

webhooks.gerenciar

Autorização

Authorizationstringobrigatórioheader

Chave da API no formato Bearer hdl_live_.... Crie no painel da loja em Integração › API e webhooks. Saiba mais.

Parâmetros de caminho

idintegerobrigatóriopath

Identificador do webhook.

Resposta

204 No Content — sem corpo na resposta.

Erros possíveis

HTTP	código	quando
`401`	`nao_autenticado`	Faltou o cabeçalho Authorization: Bearer <chave>.
`401`	`chave_invalida`	Chave inexistente ou revogada.
`403`	`sem_permissao`	A chave não tem o escopo exigido pelo endpoint.
`404`	`nao_encontrado`	O recurso não existe nesta loja.
`404`	`rota_nao_encontrada`	Endereço inexistente na API v1.

const resposta = await fetch('https://api.hoteldaslojas.com.br/v1/webhooks/1', { method: 'DELETE', headers: { 'Authorization': `Bearer ${process.env.HDL_CHAVE}` } }); console.log(resposta.status); // 204

import os, requests resposta = requests.delete( "https://api.hoteldaslojas.com.br/v1/webhooks/1", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, timeout=30, ) resposta.raise_for_status() print(resposta.status_code) # 204

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/webhooks/1'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'DELETE', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE')], ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "erro": { "codigo": "sem_permissao", "mensagem": "Esta chave não tem o escopo \"pedidos.ler\". Crie uma chave com esse escopo no painel da loja (Integração › API).", "request_id": "req_95f4a872c180063c" } }