Skip to main content
GET
Listar eventos disponíveis
GET /webhooks/listeners Faz parte do recurso Webhooks — o cadastro e as regras de assinatura estão lá. Retorna todos os códigos de evento que a Z2Pay emite, cada um com uma descrição curta. É a lista válida para o campo events ao criar ou atualizar um webhook. Não aceita parâmetros e não pagina.
Use como validação, não como enfeite. Código fora deste catálogo é recusado com 400 no cadastro. Se você monta a lista de eventos a partir de configuração do seu lado, confira contra esta resposta antes de enviar — é mais barato que descobrir pelo erro.
O catálogo cresce. Eventos novos entram aqui sem aviso, e um webhook com events: [] passa a recebê-los automaticamente. Se o seu receptor trata evento desconhecido como erro, prefira assinar a lista explícita.
Os códigos seguem o padrão recurso.acao. O que cada payload carrega está em Catálogo de eventos.

Exemplo

Resposta 200
Resposta abreviada: o catálogo completo tem dezenas de códigos, agrupados por recurso em Catálogo de eventos.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Response

Catálogo de eventos disponíveis

data
object[]
required

Lista de registros retornados na página atual.