Hotel das LojasHotel das LojasAPI
Buscar na documentação...Ctrl K

Webhooks

Editar Webhook

Muda endereço, eventos ou pausa/reativa

PATCH
/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.

Corpo da requisição

urlstringbody · application/json
eventosstring[]body · application/json
ativobooleanbody · application/json

true reativa e zera as falhas.

Resposta

200 — objeto { "dados": {...} } com um Webhook.

Erros possíveis

HTTPcódigoquando
401nao_autenticadoFaltou o cabeçalho Authorization: Bearer <chave>.
401chave_invalidaChave inexistente ou revogada.
403sem_permissaoA chave não tem o escopo exigido pelo endpoint.
404nao_encontradoO recurso não existe nesta loja.
404rota_nao_encontradaEndereço inexistente na API v1.
422validacaoCampos inválidos: veja o objeto "campos".

© Hotel das Lojas · API v1.0 · hoteldaslojas.com.br

PATCH/webhooks/{id}

Este endpoint precisa de uma chave da sua loja com o escopo webhooks.gerenciar. Ele altera dados de verdade.