Listar eventos
Encontre eventos pelo tipo, recurso e período de criação.
Consulte os eventos da empresa e do ambiente autenticado. Use o identificador do recurso para encontrar os eventos relacionados a uma cobrança ou estorno, mesmo sem conhecer o ID de uma entrega.
Veja Localizar um evento para interpretar os filtros e continuar a paginação.
Parâmetros de consulta
Quantidade de eventos por página. A resposta informa se há outra página e o cursor para consultá-la.
De 1 a 100
Cursor de page.next_after para avançar na mesma consulta. Mantenha os filtros usados na primeira página.
Até 128 caracteres
Cursor de page.previous_before para retornar na mesma consulta. Mantenha os filtros usados na primeira página.
Até 128 caracteres
Filtra pelo nome do evento, como charge.paid.
Até 100 caracteres
Filtra pelo identificador público do recurso relacionado ao evento, como uma cobrança, um estorno ou um webhook usado em teste.
Até 128 caracteres
Filtra eventos criados a partir deste instante, inclusive, em segundos Unix UTC.
De 0 a 253402300799
Filtra eventos criados até este instante, inclusive, em segundos Unix UTC. Se informar created_gte, este valor deve ser maior ou igual a ele.
De 0 a 253402300799
Respostas
Corpo da resposta
Eventos encontrados e cursores para continuar a mesma consulta.
Eventos encontrados na página atual.
Identificador do evento. É preservado nos reenvios.
Nome do evento que originou a notificação.
Instante em que o evento foi criado, em segundos Unix UTC.
Tipo do recurso relacionado ao evento.
Identificador público do recurso relacionado ao evento.
Cursores e indicação de páginas disponíveis.
Quantidade efetiva de registros por página.
Indica se há outra página para avançar.
Indica se há outra página para voltar.
Cursor para usar em after, ou null quando não há próxima página.
Cursor para usar em before, ou null quando não há página anterior.
Corpo da resposta
O período, o tipo de evento, o recurso ou o cursor informado é inválido.
Código e explicação do erro retornado pela API.
Código estável do erro.
Explicação do erro em inglês. Em validações, resume a categoria; os detalhes identificam as correções. Use os códigos para tratar a resposta.
Falhas em campos recebidos ou referências enviadas no corpo, com campo, código e explicação. Omitido em erros gerais e quando não há correção de campo a indicar.
Nome público do campo JSON, parâmetro de consulta, parâmetro de rota ou header relacionado ao erro. Campos aninhados e listas preservam o caminho e o índice. $ representa a raiz do corpo JSON.
Motivo do erro no campo, como REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD ou INVALID_TYPE.
Explicação em inglês sobre o problema nesse campo ou parâmetro e a correção disponível. Não use o texto para decidir o fluxo da integração.
Para os erros gerais, consulte Códigos HTTP das respostas.