Apply a Canvas drawing event

POST

/api/v1/collab/notes/{id}/events

const url = 'https://example.com/api/v1/collab/notes/example/events';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"elements":["example"],"font":"example"}'
};

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

curl --request POST \
  --url https://example.com/api/v1/collab/notes/example/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "elements": [ "example" ], "font": "example" }'

Validate and save a bounded Canvas element event through the existing Note writer. The authenticated owner’s stable identity selects the room. Route: /api/v1/collab/notes/{id}/events. Inputs: id. Do not automatically replay this operation after an uncertain result.

Authorizations

installationBearer
browserSession

Parameters

Path Parameters

required

string

Request Body^required

application/json

Canvas event envelope shared by HTTP tools and the web room (§60, #976). A remove is an element with isDeleted: true and a newer version.

object

elements

required

Array

font

Shared text style; omitted during ordinary drawing edits (§60).

string | null

/^(hand-drawn|app)$/

Example^generated

{
  "elements": [
    "example"
  ],
  "font": "example"
}

Responses

204

Canvas event saved

404

Canvas not found

422

Invalid Canvas event

429

Event limit reached