Listar eventos

Retorna todos os eventos.

Os itens são retornados e ordenados por data de criação, com os itens mais recentes primeiro.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

event_type

string

Um filtro com base no campo eventType da empresa. O valor deve ser uma string ou uma lista separada por vírgula, que represente um ou um conjunto de tipos de eventos.

data_id

string

Um filtro com base no campo id, dentro do objeto data. O valor deve ser uma string, que representa o id de alguma entidade da Base39.

expand

string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

starting_after

string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

ending_before

string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

limit

integer

default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

fields

string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Response

200 - application/json

Um objeto com uma propriedade `data` que contém um array de itens começando após o item `starting_after`. Cada entrada no array é um objeto `Event` separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de eventos.

hasMore

boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

data

object[]

Uma lista de eventos

Este objeto representa um evento.

Show child attributes

data.id

string

Identificador exclusivo para o objeto.

Example:

"evnt_63eb84cc5ebbf96915062ecb"

data.eventType

string

Tipo do evento.

Example:

"customer.updated"

data.data

object

Corpo da mensagem enviado pelo webhook

Example:

{
  "id": "cust_63eb84cc5ebbf96915062ec9",
  "name": "name",
  "username": "username"
}

data.subscriptions

object[]

Show child attributes

data.subscriptions.status

enum<string>

Available options:

processing,

processed

Example:

"processing"

data.subscriptions.id

string

Identificador da assinatura do webhook

Example:

"subs_63c07a9c8d701377c9423148"

data.metadata

object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"