Listar eventos disponíveis
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/webhooks/listeners \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/webhooks/listeners', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/webhooks/listeners"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"code": "<string>",
"description": "<string>",
"resource": "<string>",
"status": "available"
}
]
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}Webhooks
Listar eventos disponíveis
O catálogo dos códigos de evento que podem ser assinados por um webhook.
GET
/
webhooks
/
listeners
Listar eventos disponíveis
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/webhooks/listeners \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/webhooks/listeners', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/webhooks/listeners"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"code": "<string>",
"description": "<string>",
"resource": "<string>",
"status": "available"
}
]
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}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.recurso.acao. O que cada payload carrega está em
Catálogo de eventos.
Exemplo
curl https://api.sandbox.z2pay.com/v1/webhooks/listeners \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
Resposta 200
{
"data": [
{ "code": "transaction.created", "description": "Transação criada" },
{ "code": "transaction.paid", "description": "Transação paga" },
{ "code": "transaction.refused", "description": "Transação recusada" },
{ "code": "payment.paid", "description": "Pagamento aprovado" },
{ "code": "customer.created", "description": "Cliente criado" },
{ "code": "recipient.approved", "description": "Recebedor aprovado" },
{ "code": "withdrawal.paid", "description": "Saque pago" },
{ "code": "invoice.issued", "description": "Fatura emitida" },
{ "code": "subscription.activated", "description": "Assinatura ativada" }
]
}
Resposta abreviada: o catálogo completo tem dezenas de códigos, agrupados por recurso em
Catálogo de eventos.