v1

latestOpenAPI 3.1.02026-08-043160244.3 KB

Event Checkpoints

Create or get an event checkpoint

Create a new named event checkpoint, or return the existing one if it already exists.

On creation, the cursor is initialised to initial_cursor if provided, or to the current end of the event stream otherwise. initial_cursor is ignored if the checkpoint already exists.

put/event/checkpoint/{name}

Path parameters

namestring required

Request body

initial_cursorstring nullable

Cursor token (ev1.*) to initialise the checkpoint at. Only used when the checkpoint is created — ignored if it already exists. If omitted on creation, defaults to the current end of the event stream.

Example request

{
  "initial_cursor": "ev1...."
}

Response

Checkpoint state with created flag

createdboolean required

True if the checkpoint was newly created, False if it already existed

Example response

{
  "checkpoint": {
    "checkpointVersion": "ec1....",
    "cursor": "ev1....",
    "name": "my-checkpoint",
    "uid": "01JKXYZ...",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}