Events Handbook

Events are used throughout the Canvas Core as the way to interact and modify behaviour of the rest of the system.

This Handbook aims to give you a list and small description of all events dispatched by our APIs.

For more information about events and how to use them, check their documentation page here

Goal Events

class canvas_core.goals.events.GoalEvent(**attrs: Any)

Base class for all Goal-related events, so they all have the same properties.

class canvas_core.goals.events.GoalUpdateData

Class to Update/Close event method to add diffable data.

class canvas_core.goals.events.PostGoalClose(**attrs: Any)

Emitted after a Goal is closed.

class canvas_core.goals.events.PostGoalCreate(**attrs: Any)

Emitted after a Goal is created.

class canvas_core.goals.events.PostGoalUpdate(**attrs: Any)

Emitted after a Goal is updated.

class canvas_core.goals.events.PreGoalClose(**attrs: Any)

Emitted before a Goal is closed.

class canvas_core.goals.events.PreGoalCreate(**attrs: Any)

Emitted before a Goal is created.

class canvas_core.goals.events.PreGoalUpdate(**attrs: Any)

Emitted before a Goal is updated.

Note Events

class canvas_core.notes.events.PostNoteCreate(**attrs: Any)

Emitted after a note is created.

class canvas_core.notes.events.PostNoteUpdate(**attrs: Any)

Emitted after a note is updated.

class canvas_core.notes.events.PreNoteCreate(**attrs: Any)

Emitted before a note is created.

class canvas_core.notes.events.PreNoteUpdate(**attrs: Any)

Emitted before a note is updated.

Plugin Events

class canvas_core.plugins.events.PluginInitializationFailed(**attrs: Any)

An event emitted after a plugin has failed to initialize.

class canvas_core.plugins.events.PluginInitialized(**attrs: Any)

An event emitted after a plugin has been successfully initialized.

Record Events

class canvas_core.events.records.PostRecordCreate(**attrs: Any)

Emitted after a record has been created in the database.

class canvas_core.events.records.PostRecordDelete(**attrs: Any)

Emitted after a record is deleted from the database.

class canvas_core.events.records.PostRecordUpdate(**attrs: Any)

Emitted after a record has been updated in the database.

class canvas_core.events.records.PreRecordCreate(**attrs: Any)

Emitted before a record is created in the database.

class canvas_core.events.records.PreRecordDelete(**attrs: Any)

Emitted before a record is deleted from the database.

class canvas_core.events.records.PreRecordUpdate(**attrs: Any)

Emitted before a record is updated in the database.

class canvas_core.events.records.RecordEvent(**attrs: Any)

An event related to an operation on a database record.

Search Events

class canvas_core.search.events.PostSearch(**attrs: Any)

Emitted after a search request is executed.

class canvas_core.search.events.PreSearch(**attrs: Any)

Emitted before a search request is executed.

class canvas_core.search.events.SearchEvent(**attrs: Any)

Generic search event.

Templating Events

class canvas_core.templating.events.PostTemplateRender(**attrs: Any)

An event emitted after a template is rendered.

class canvas_core.templating.events.PreTemplateRender(**attrs: Any)

An event emitted immediately before a template is rendered.

class canvas_core.templating.events.TemplateRenderEvent(**attrs: Any)

Parent class of all template render events.