Listar webhooks
Webhooks
Listar webhooks
Lista paginada dos webhooks da sua conta, com filtro por ativação e por evento assinado.
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
API Key da Credential (gerada no Backoffice)
Query Parameters
Filtra por webhooks ativos (true) ou inativos (false). Omitido, traz ambos.
Available options:
true, false 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.
Número da página a retornar.
Required range:
x > 0Quantidade de itens por página.
Required range:
0 < x <= 100