Listar webhooks
Liste os webhooks cadastrados, com filtros e paginação.
Lista os webhooks cadastrados.
GET /webhooks
Requer autenticação. Envie suas credenciais no header Authorization. Veja Autenticação.
Requisição
GET /webhooks?take=100&skip=0&object=PAYMENT
Authorization: Basic <suas_credenciais_em_base64>Parâmetros
Prop
Type
Resposta
{
"items": [
{
"id": "a80c22da-2433-4ae5-95a8-f25e30737cb9",
"callback_url": "https://api.mycompany.com/paggpix-payment-webhook",
"object": "PAYMENT",
"created": "2024-08-10T14:43:05.894Z"
}
],
"start": 0,
"end": 1,
"total": 1
}Campos da resposta (paginação)
Prop
Type
Webhook
Prop
Type
Exemplos
curl "https://public-api.paggpix.com/webhooks?take=100&skip=0&object=PAYMENT" \
-H "Authorization: Basic <suas_credenciais_em_base64>"const axios = require('axios');
const CLIENT_ID = '<seu_client_id>';
const CLIENT_SECRET = '<seu_client_secret>';
const CREDENTIALS = Buffer.from(`${CLIENT_ID}:${CLIENT_SECRET}`).toString('base64');
const BASE_URL = 'https://public-api.paggpix.com';
async function listWebhooks() {
try {
const { data } = await axios.get(`${BASE_URL}/webhooks`, {
params: { take: 100, skip: 0, object: 'PAYMENT' },
headers: { Authorization: `Basic ${CREDENTIALS}` },
});
console.log(`Found ${data.total} webhooks`);
data.items.forEach((webhook) => {
console.log(`Webhook: id = ${webhook.id}, callback_url = ${webhook.callback_url}`);
});
} catch (error) {
console.error(error.response ? error.response.data : error.message);
}
}