Notificações Webhook (Saída)
Este módulo permite listar e visualizar o histórico de notificações enviadas pelo sistema para as URLs de webhook configuradas em suas cobranças.
Listar Notificações
[GET] /webhook-notifications
Retorna uma lista paginada de todas as notificações enviadas para a conta.
Parâmetros de Consulta (Query Params)
| Parâmetro | Tipo | Descrição |
|---|---|---|
status | string | Filtra por status: pending, sent, failed. |
event | string | Filtra por nome do evento (ex: charge.paid). |
charge_id | integer | Filtra notificações de uma cobrança específica. |
search | string | Busca por URL, evento ou código da cobrança. |
created_at_start | date | Data inicial (Y-m-d). |
created_at_end | date | Data final (Y-m-d). |
per_page | integer | Quantidade por página (Padrão: 15). |
page | integer | Número da página. |
Resposta (200 OK)
json
{
"data": [
{
"id": 125,
"account_id": 1,
"charge_id": 450,
"status": "sent",
"url": "https://meusite.com/webhook",
"event": "charge.paid",
"attempts": 1,
"payload": {
"event": "charge.paid",
"data": {
"code": "ch_xyz123",
"amount_paid": 250.0,
"paid_at": "2024-12-26T16:15:00Z"
}
},
"response": {
"message": "OK"
},
"last_attempt_at": {
"raw": "2024-12-26 16:15:05",
"formatted": "26/12/2024 16:15:05"
},
"created_at": {
"raw": "2024-12-26 16:15:00",
"formatted": "26/12/2024 16:15:00"
},
"updated_at": {
"raw": "2024-12-26 16:15:05",
"formatted": "26/12/2024 16:15:05"
},
"charge": {
"id": 450,
"code": "ch_xyz123",
"value": 250.0
}
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}Ver Detalhes da Notificação
[GET] /webhook-notifications/{id}
Retorna os detalhes completos de uma única notificação, incluindo o payload enviado e a resposta recebida.
Resposta (200 OK)
json
{
"data": {
"id": 125,
"account_id": 1,
"charge_id": 450,
"status": "sent",
"url": "https://meusite.com/webhook",
"event": "charge.paid",
"attempts": 1,
"payload": { ... },
"response": { ... },
"last_attempt_at": { ... },
"created_at": { ... },
"updated_at": { ... },
"charge": { ... }
}
}