Developer

Listener Events for v2

Below is a table of the event types that can be subscribed to when creating listeners. More details about Listeners can be found in the Listeners page.

Please remember that the term "Listener" must be understood from your perspective, as the API user interacting with a Workspace: you will set a Listener to listen to events that occur in that Workspace.

Event Type Description
ALL All events for all objects.
BROWSER_ALL A browser was created, deleted or updated.
BROWSER_CREATE A browser was created.
BROWSER_DELETE A browser was deleted.
BROWSER_UPDATE A browser was updated.
CANVAS_ALL A canvas was created, deleted or updated.
CANVAS_CREATE A canvas was created.
CANVAS_DELETE A canvas was deleted.
CANVAS_UPDATE A canvas was updated.
COMMENT_ALL A comment was created, deleted or updated.
COMMENT_CREATE A comment was created.
COMMENT_DELETE A comment was deleted.
COMMENT_UPDATE A comment was updated.
DOCUMENT_ALL A document was created, deleted or updated.
DOCUMENT_CREATE A document was created.
DOCUMENT_DELETE A document was deleted.
DOCUMENT_UPDATE A document was updated.
IMAGE_ALL An image was created, deleted or updated.
IMAGE_CREATE An image was created.
IMAGE_DELETE An image was deleted.
IMAGE_UPDATE An image was updated.
NOTE_ALL A note was created, deleted or updated.
NOTE_CREATE A note was created.
NOTE_DELETE A note was deleted.
NOTE_UPDATE A note was updated.
STROKE_ALL A stroke was created, deleted or updated.
STROKE_CREATE A stroke was created.
STROKE_DELETE A stroke was deleted.
STROKE_UPDATE A stroke was updated.
TEXT_ALL A text element was created, deleted or updated.
TEXT_CREATE A text element was created.
TEXT_DELETE A text element was deleted.
TEXT_UPDATE A text element was updated.