Buscar webhook por ID
Webhooks
Buscar webhook por ID
Retorna a configuração de um webhook — URL, eventos assinados, situação e se ele assina as entregas.
GET
Buscar webhook por ID
GET /webhooks/:id
Faz parte do recurso Webhooks — o cadastro e o catálogo de eventos estão lá.
Retorna a configuração atual de um webhook. É a leitura que responde “este endereço ainda está
recebendo, e o quê”.
autoDisabledAt diz por que ele parou. Preenchido, o webhook foi desativado pela Z2Pay
depois de uma sequência de falhas — e nenhum evento novo é enviado desde então. null com
isActive: false significa que alguém o desativou de propósito. O critério da desativação
automática está em Entrega e retentativas.secretHint não serve para verificar assinatura — é um fragmento, só para você reconhecer
qual segredo está configurado. O valor completo aparece uma única vez, na
criação.Exemplo
Resposta 200
Authorizations
API Key da Credential (gerada no Backoffice)
Path Parameters
ID do webhook
Response
Dados do webhook
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).