Watch Canvas card changes

GET

/api/v1/canvas/cards/events

const url = 'https://example.com/api/v1/canvas/cards/events';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/canvas/cards/events \
  --header 'Authorization: Bearer <token>'

Stream bounded change notifications for the authenticated User. Clients resolve affected cards again under current target access. Route: /api/v1/canvas/cards/events. Inputs: canvas_id. Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Parameters

Query Parameters

canvas_id

string

Canvas whose own Note save events must not trigger card re-resolution.

Responses

200

Viewer-scoped Canvas card invalidations

text/event-stream

204

Anonymous viewers receive no item invalidations

400

Invalid Canvas identity

429

Concurrent event stream limit reached