Listar eventos

GET 
/v1/events

Retorna todos os eventos, ordenados por data de criação, com os mais recentes primeiro.

Request

Query Parameters

event_type string

Filtro no campo eventType da empresa, aceitando string ou lista separada por vírgula para tipos de eventos.

Examples:

single

Valor único

Example: loan.created

list

Lista

Example: loan.created,customer.created

data_id string
Filtro no campo id dentro do objeto data, aceitando uma string que representa o id de uma entidade da Base39.
Example: cust_63eb84cc5ebbf96915062ec9
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.
Example: data.loan
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.
Example: obj_5f92f01728e009f403d8502e
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.
Example: obj_5f92f01728e009f403d8502e
limit integer
Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.
Default value: 10
Example: 10
fields string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

Responses

200

Objeto com data contendo array de Event a partir de starting_after; vazio se não houver mais itens. Solicitação nunca retorna erro.

application/json

Schema

Schema

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

Array [

id string

Identificador exclusivo para o objeto.

Example: evnt_63eb84cc5ebbf96915062ecb

eventType string

Tipo do evento.

Example: customer.updated

data object

Corpo da mensagem enviado pelo webhook

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

subscriptions

object[]

Array [

status

Possible values: [processing, processed]

Example: processing

id string

Identificador da assinatura do webhook

Example: subs_63c07a9c8d701377c9423148

]

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.

createdAt date-time

Data de criação do objeto

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

]

Example (from schema)

{
  "hasMore": true,
  "data": [
    {
      "id": "evnt_63eb84cc5ebbf96915062ecb",
      "eventType": "customer.updated",
      "data": {
        "id": "cust_63eb84cc5ebbf96915062ec9",
        "name": "name",
        "username": "username"
      },
      "subscriptions": [
        {
          "status": "processing",
          "id": "subs_63c07a9c8d701377c9423148"
        }
      ],
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z"
    }
  ]
}

Loading...