Skip to main content
GET
Listar webhooks
GET /webhooks Faz parte do recurso Webhooks — a configuração e o catálogo de eventos estão lá. Retorna a lista paginada dos webhooks da sua conta. Os dois filtros são opcionais e podem ser combinados.
event responde “quem seria notificado se isso acontecesse”. Ele traz os webhooks inscritos naquele evento, com correspondência exata e um valor por requisição — ?event=transaction.paid. A lista de eventos válidos está em Listar eventos disponíveis.
O secret não vem nesta resposta — nem em nenhuma outra leitura. Ele sai em claro uma única vez, na criação do webhook. Aqui vêm no lugar hasSecret, que confirma que o webhook assina as entregas, e secretHint, um fragmento para você reconhecer qual segredo está configurado.Perdeu o valor? Não há como relê-lo, e nenhuma rota o troca: a rotação é feita no painel. Pela API, o equivalente é criar outro webhook com o mesmo destino e remover o antigo.
autoDisabledAt preenchido é um alarme. Significa que a Z2Pay desativou aquele webhook por falhas seguidas, e nada está sendo entregue nele desde então. Vale uma varredura periódica por este campo — o critério está em Entrega e retentativas.

Exemplo

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Query Parameters

isActive
enum<string>

Filtra por webhooks ativos (true) ou inativos (false). Omitido, traz ambos.

Available options:
true,
false
event
string

Retorna os webhooks inscritos neste evento. Um valor por requisição, correspondência exata (ex.: transaction.paid). A lista completa está em GET /webhooks/listeners.

page
integer
default:1

Número da página a retornar.

Required range: x > 0
limit
integer
default:20

Quantidade de itens por página.

Required range: 0 < x <= 100

Response

Lista paginada de webhooks

data
object[]
required

Lista de registros retornados na página atual.

pagination
object
required

Dados de paginação do resultado.