Skip to content

Change feed

Change feed for sync (since an opaque cursor)

Section titled “Change feed for sync (since an opaque cursor)”

GET /api/v1/apps/{appId}/changes

The app’s change feed, for sync: what was created, updated or deleted since a cursor. Query parameters: since (the next value of the last answer; leave it out to start from the beginning, or send latest to start from now) and limit (default 100, at most 1000). Store next and send it back. When resync is true, the cursor cannot be continued: reload what you show, then follow the feed from next. Apps poll this; there is no push channel.

Who may call it: The console session (its cookie, and X-CSRF-Token on writes), an API token with a scope for this app (Authorization: Bearer oak_pat_...) or the app’s own access token (Authorization: Bearer ...).

Path parameters: appId.

Response (200, JSON):

Field Type Required Notes
changes array of object yes
changes[].at string yes
changes[].kind string yes
changes[].op string yes
changes[].rowId string yes
changes[].seq integer yes
changes[].table string yes
next string yes
resync boolean no

Errors: 400, 401, 403, 404, 429, as described in errors.

Terminal window
curl -X GET "https://node.example.com/api/v1/apps/{appId}/changes" \
-H "Authorization: Bearer $TOKEN"

Built from spec 2.1.0, SDK 2.0.0 and the node's guide at v0.6.0-alpha.1.