No results

Event log

Every time something is created, updated, or deleted, we generate an event.

These events can be used to restore items to a previous state, or simply for auditing purposes.

Viewing events

We can view events for a specific object using the following endpoints:

Fetch events for a list

Get a paginated list of events for a specific list.

Fetch events for an item

Get a paginated list of events for a specific item.

Fetch events for an index

Get a paginated list of events for a specific index.

Event object

{
id: "b1005023-9e42-42f9-bac9-fbd5d7818f71"
createdAt: "2026-09-05T11:29:28.808Z"
updatedAt: "2026-09-05T11:29:28.808Z"
user: {
id: "8c571227-e406-4bae-9a14-ef11247bd0d7"
createdAt: "2026-09-05T11:29:28.808Z"
updatedAt: "2026-09-05T11:29:28.808Z"
lastActiveAt: "2026-09-05T11:29:28.808Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "3bbe6563-ca1f-4f76-a8fa-63269e130382"
stream: "list"
type: "list-created"
version: null
snapshot: {
}
attachments: {
}
}
  • idstringUnique identifier for the event.
  • createdAtstringDate and time the event was created in ISO 8601 format.
  • updatedAtstring

    Date and time the event was last updated in ISO 8601 format.

    Events are generally immutable, so this will be the same as thecreatedAt value. There might be situations where the event is updated, such as correcting a mistake or adding additional information.

  • userobjectThe user who created the event.
    User attributes
    • idstringUnique identifier for the user.
    • createdAtstringDate and time the user registered in ISO 8601 format.
    • updatedAtstringDate and time the user was last updated in ISO 8601 format.
    • lastActiveAtstringDate and time the user was last active in ISO 8601 format.
    • activatedbooleanWhether the user account is activated.
    • displayNamestringThe user's display name.
    • descriptionstringThe user's description.
  • modelIdstringThe id of the object affected by this event.
  • streamstring

    The type of object affected by this event.

    Valid values are:

    • list
    • item
    • index
  • typestring

    The type of this event.

    Valid values are:

    • list-created
    • list-updated
    • list-deleted
    • item-created
    • item-updated
    • item-deleted
    • item-restored
    • index-created
    • index-updated
    • index-deleted
  • versionstringIf this event is for an item, this will contain the item's version at the time this event was created.
  • snapshotobjectA snapshot of the object taken before the event was created.
  • attachmentsnullable object

    Metadata attached to the event.

    Generally this will contain request data (e.g. request body, parameters).

2024-11-15