Skip to main content
GET
/
events
List events
curl --request GET \
  --url https://api.engine.usesophic.com/events \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "resource": {
      "id": "<string>",
      "resource_type": "<string>"
    },
    "data": {},
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
name
string

Filter by fully-qualified event name, e.g. customer.created.

​
resource[id]
string

Filter by the resource ID that the events describe.

​
created[gt]
string<date-time>

Return events created strictly after this timestamp.

​
created[gte]
string<date-time>

Return events created on or after this timestamp.

​
created[lt]
string<date-time>

Return events created strictly before this timestamp.

​
created[lte]
string<date-time>

Return events created on or before this timestamp.

Response

OK

​
id
string
required

Unique resource identifier.

​
name
string
required

Fully-qualified event name, e.g. customer.created.

​
resource
EventResource · object
required

The resource that the event relates to.

​
data
Data · object
required

Event-specific payload data.

​
created_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the event was recorded.