Skip to main content
GET
/
api
/
webhook-events
Listar Eventos de Webhook
curl --request GET \
  --url https://garu.com.br/api/webhook-events \
  --header 'Authorization: Bearer <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.garu.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Visão Geral

Retorna uma lista paginada dos eventos de webhook emitidos pelo seller autenticado — entregues, pendentes e com falha. É a chamada por trás da aba Eventos em Configurações → Webhooks do dashboard. Disponível a partir da v0.10.3. Aceita chave de API (sk_test_… / sk_live_…) ou JWT do dashboard.

​
Exemplo de Requisição

# Últimos eventos que falharam
curl -X GET "https://garu.com.br/api/webhook-events?status=failed&limit=5" \
  -H "Authorization: Bearer sk_test_sua_chave"

# Eventos de pagamento confirmado de um endpoint específico
curl -X GET "https://garu.com.br/api/webhook-events?eventType=transaction.payment.succeeded&endpointId=7" \
  -H "Authorization: Bearer sk_test_sua_chave"

​
Parâmetros de Query

​
status
string
Filtra por status de entrega. Valores: pending, success, failed.
​
eventType
string
Filtra por tipo de evento (ex: transaction.payment.succeeded, scheduled_charge.cycle_failed). Use os mesmos identificadores documentados em Webhooks → Eventos Disponíveis.
​
endpointId
number
Restringe a eventos entregues a um endpoint específico.
​
page
number
default:"1"
Página da paginação.
​
limit
number
default:"20"
Itens por página (máx. 100).

​
Resposta

{
  "data": [
    {
      "id": 12345,
      "endpointId": 7,
      "eventType": "transaction.payment.succeeded",
      "status": "failed",
      "attempts": 6,
      "lastResponseStatus": 503,
      "createdAt": "2026-05-18T14:22:11Z",
      "deliveredAt": null,
      "payload": {
        "id": "evt_1a2b3c",
        "type": "transaction.payment.succeeded",
        "data": { "object": { "id": 999, "value": 49.9 } }
      }
    }
  ],
  "meta": { "page": 1, "limit": 20, "total": 1, "totalPages": 1 }
}

​
Campos

CampoTipoDescrição
idnumberID numérico do evento (use em get e retry)
endpointIdnumberID do endpoint configurado em Configurações → Webhooks
eventTypestringTipo do evento Garu (ex: transaction.payment.succeeded)
statusstringpending, success ou failed
attemptsnumberQuantas tentativas de entrega foram feitas
lastResponseStatusnumber|nullCódigo HTTP da última resposta do seu endpoint
deliveredAtstring|nullISO timestamp da entrega bem-sucedida (se status success)
payloadobjectPayload completo enviado ao seu endpoint
Os eventos ficam retidos por 30 dias. Para auditoria de longo prazo, persista os webhooks no seu lado conforme os recebe.