Sign in

v1

latestOpenAPI 3.1.02026-08-043160244.3 KB
Event Checkpoints

Advance an event checkpoint cursor

Advance the checkpoint to a new cursor position.

Supply the new_cursor to move to. If you also provide the expected_checkpoint_version from the last read, the request uses it as an optimistic lock and returns 409 Conflict if the checkpoint has changed since you last read it.

patch/event/checkpoint/{name}

Path parameters

namestring required

Request body

expected_checkpoint_versionstring nullable

Optional checkpointVersion value from your last read of this checkpoint. If supplied and it no longer matches the current version, the request returns 409 Conflict.

new_cursorstring required

New cursor token (ev1.*) to advance the checkpoint to

Example request

{
  "expected_checkpoint_version": "ec1....",
  "new_cursor": "ev1...."
}

Response

Updated checkpoint state

Example response

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