Listar Eventos

Consulte e filtre eventos de notificações processadas pela plataforma.

Visão Geral

Os endpoints de consulta de eventos permitem recuperar e consultar o histórico completo de notificações processadas pela plataforma. Use este endpoint para auditoria, troubleshooting de webhooks ou análise de eventos específicos. É possível filtrar por status, tipo de evento, data de criação e paginar os resultados.

Endpoint

GET/v1/webhooks/events

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
status	string	✓	Filtrar por status do evento: pending, failed, processed
type	string	✓	Filtrar por tipo de evento
created_at	string	—	Filtrar por data de criação
cursor	string	—	Token de paginação retornado pela resposta anterior. Omitir na primeira página.
limit	integer	—	Itens por página (padrão: 20, máximo: 100)
order_by	string	—	Campo para ordenação: created_at
sort	string	—	Direção da ordenação: ASC ou DESC

Response

{
  "metadata": {
    "nextCursor": "d3skoqrr425c54fi9fr1",
    "previousCursor": null,
    "limit": 20
  },
  "data": [
    {
      "id": "d3skoqrr425c54fi9fr0",
      "createdAt": "2025-10-22T21:28:11.436914699Z",
      "updatedAt": "2025-10-22T21:28:11.436914699Z",
      "type": "payment.completed",
      "status": "processed",
      "data": {
        "_comment": "objeto ilustrativo — conteúdo real conforme o type do evento (ver payment.completed / terminal.activated)"
      }
    }
  ]
}

Campos da Resposta

Resposta paginada — envelope padrão da plataforma (ver Filtros e Paginação):

Campo	Tipo	Descrição
metadata.nextCursor	string | null	Token para a próxima página. null na última página.
metadata.previousCursor	string | null	Token para a página anterior. null na primeira página.
metadata.limit	integer	Quantidade de itens retornados na página
data	array	Lista de eventos — cada item tem os campos de Event

Event

Campo	Tipo	Descrição
id	string	Identificador do evento
createdAt	string	Timestamp de criação do evento (ISO 8601)
updatedAt	string	Timestamp de atualização do evento (ISO 8601)
type	string	Tipo do evento, ex: payment.completed, terminal.activated
status	string	Status do evento: pending, failed, processed
data	object	Payload do evento; o formato depende do type (ver Data)

observação

O evento armazenado (retornado aqui) tem createdAt, updatedAt e status além dos campos entregues no corpo do webhook. O corpo entregue ao seu endpoint contém apenas id, type e data — ver Notificação.

Data

O conteúdo de data varia conforme o type do evento. Consulte a documentação de cada tipo de evento para o formato completo do payload:

• payment.completed
• terminal.activated