Ativar/desativar webhook
Webhooks
Ativar/desativar webhook
Liga e desliga o envio de notificações sem apagar o cadastro.
PATCH
Ativar/desativar webhook
PATCH /webhooks/:id/status
Faz parte do recurso Webhooks — o cadastro e o catálogo de eventos estão lá.
Liga e desliga o webhook mantendo URL, eventos e secret. É o caminho certo para pausar as
notificações durante uma manutenção do seu servidor, e o único jeito de reativar um webhook que a
Z2Pay desativou sozinho.
Reativar limpa o
autoDisabledAt. Se o webhook tinha sido desativado automaticamente por
falhas, isActive: true o traz de volta e zera o marcador. Vale conferir que o endpoint já está
respondendo 2xx antes — desativado de novo, o ciclo recomeça.Exemplo
Resposta 200
Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Path Parameters
ID do webhook
Body
application/json
Ativa (true) ou desativa (false) o webhook.
Response
Status do webhook atualizado
Identificador único do registro.
Nome do registro.
URL de destino do webhook ou link de download do arquivo.
Tipos de evento assinados pelo webhook.
Indica se o registro está ativo.
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).