Calendar Event Management

Last updated: 4 Dec 2025

Overview #

This allows developers to create, update, and delete calendar events for providers in Canvas. Events can be one-time or recurring, with support for daily and weekly recurrence patterns.

from canvas_sdk.effects.calendar import Event, EventRecurrence, DaysOfWeek
from datetime import datetime

# Create a one-time event
Event(
    calendar_id="calendar-uuid",
    title="Patient Consultation",
    starts_at=datetime(2025, 1, 15, 9, 0),
    ends_at=datetime(2025, 1, 15, 10, 0)
).create()

# Create a recurring event
Event(
    calendar_id="calendar-uuid",
    title="Weekly Team Meeting",
    starts_at=datetime(2025, 1, 15, 14, 0),
    ends_at=datetime(2025, 1, 15, 15, 0),
    recurrence_frequency=EventRecurrence.Weekly,
    recurrence_interval=1,
    recurrence_days=[DaysOfWeek.Monday, DaysOfWeek.Wednesday],
    recurrence_ends_at=datetime(2025, 12, 31, 23, 59),
    allowed_note_types=["100", "101"]
).create()

# Update an existing event
Event(
    event_id="event-uuid",
    title="Updated Meeting Title",
    starts_at=datetime(2025, 1, 15, 15, 0),
    ends_at=datetime(2025, 1, 15, 16, 0)
).update()

# Delete an event
Event(event_id="event-uuid").delete()

Structure #

EventRecurrence #

An enumeration of recurrence frequency options:

Value	Description
`Daily`	Event recurs daily
`Weekly`	Event recurs weekly

DaysOfWeek #

An enumeration of days of the week for recurring events:

Value	Description
`MO`	Monday
`TU`	Tuesday
`WE`	Wednesday
`TH`	Thursday
`FR`	Friday
`SA`	Saturday
`SU`	Sunday

Event #

An Event effect consists of the following properties:

Attributes #

Attribute	Type	Description
`calendar_id`	`str \\| UUID \\| None`	The calendar UUID where the event will be created.
`event_id`	`str \\| UUID \\| None`	The event UUID to update.
`title`	`str \\| None`	The title of the event.
`starts_at`	`datetime \\| None`	The start date and time of the event.
`ends_at`	`datetime \\| None`	The end date and time of the event.
`recurrence_frequency`	`EventRecurrence \\| None`	The frequency of recurrence - either `EventRecurrence.Daily` or `EventRecurrence.Weekly`.
`recurrence_interval`	`int \\| None`	The interval between recurrences (e.g., 1 for every week, 2 for every other week).
`recurrence_days`	`list[DaysOfWeek] \\| None`	List of days when the event should recur (used with weekly recurrence).
`recurrence_ends_at`	`datetime \\| None`	The date and time when the recurrence pattern ends.
`allowed_note_types`	`list[str] \\| None`	List of note types that are allowed for this event.