Skip to main content
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

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

id
string
required

ID do webhook

Response

Dados do webhook

id
string
required

Identificador único do registro.

name
string
required

Nome do registro.

url
string<uri>
required

URL de destino do webhook ou link de download do arquivo.

events
string[]
required

Tipos de evento assinados pelo webhook.

isActive
boolean
required

Indica se o registro está ativo.

hasSecret
boolean
required
secretHint
string | null
required
autoDisabledAt
string<date-time> | null
required
createdAt
string<date-time>
required

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>
required

Data e hora da última atualização do registro (ISO 8601).