Skip to main content

CheckpointData

checkpointVersionstringrequired

Opaque version token (ec1.*) representing the current state of this checkpoint. Pass this as expected_checkpoint_version when advancing the cursor via PATCH — if the checkpoint has changed since you read it, the request will return 409 Conflict.

Example: ec1....
cursorstringrequired

Opaque cursor token (ev1.*) pointing to the current stream position

Example: ev1....
namestringrequired

Checkpoint name

Example: my-checkpoint
uidstringrequired

Unique identifier for the checkpoint

Example: 01JKXYZ...
updatedAtstringrequired

ISO 8601 timestamp of the last update

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