Obter informações de um evento executado

GET 
/v1/events/:event

Retorna um objeto Event

Request

Path Parameters

event stringrequired
ID do evento
Example: evnt_5f92f01728e009f403d8502e

Query Parameters

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
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

Retorna o objeto Event para um ID válido.

application/json

Schema

Schema

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)

{
  "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...