Histórico de entregas
Consulta o histórico de tentativas de entrega dos webhooks (sucesso, falha, pendente), com filtros e paginação.
Overview
Use para debugar falhas de entrega ou auditar notificações. Filtre por webhookId, status, eventType e período.
Endpoint
GETGET /webhooks/deliveries
Base URL:
https://api.onnixpay.com/api/v1/sdkHeaders
| Header | Obrigatório | Descrição |
|---|---|---|
| X-API-Key | Sim | Sua API Key. |
Query Parameters
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| webhookId | string | Não | Filtrar por ID do webhook. |
| status | string | Não | Filtrar por status da entrega. |
| eventType | string | Não | Filtrar por tipo de evento. |
| startDate | string | Não | Data inicial do período (ISO 8601). |
| endDate | string | Não | Data final do período (ISO 8601). |
| page | number | Não | Página. Padrão: 1. |
| limit | number | Não | Itens por página. Padrão: 20. |
Exemplo cURL
cURL
curl -X GET "https://api.onnixpay.com/api/v1/sdk/webhooks/deliveries?status=success" \
-H "X-API-Key: ox_sua_chave_aqui"Response — Sucesso (200)
JSON
{
"data": [
{
"id": "del_001",
"webhookId": "wh_001",
"eventType": "transaction.completed",
"status": "success",
"statusCode": 200,
"deliveredAt": "2025-02-09T12:00:01.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| data | array | Lista de entregas. Cada item: id, webhookId, eventType, status, statusCode, deliveredAt. |
| pagination | object | page, limit, total, totalPages. |
Status codes e erros comuns
| Status | Código | Mensagem |
|---|---|---|
| 401 | INVALID_API_KEY | Chave de API inválida ou ausente. |