Skip to main content

Availability events

Availability slots and blockers on the practice calendar. Recurring events relate to weekly patterns; specific events relate to one-off date overrides.

Blocker note: availability.blocker.* events can refer to either an availability record (availabilityId) or an unavailable booking (bookingId, with optional patientId and doctorId). Check which identifier key is present to know which API to call.

Event typeDescriptionIdentifiers
availability.blocker.createdA calendar blocker was createdavailabilityId or bookingId; optional patientId, doctorId (booking blockers only)
availability.blocker.updatedA calendar blocker was updatedSame as availability.blocker.created
availability.blocker.removedA calendar blocker was removedSame as availability.blocker.created
availability.recurring.createdA recurring weekly availability slot was createdavailabilityId
availability.recurring.updatedA recurring weekly availability slot was updatedavailabilityId
availability.recurring.removedA recurring weekly availability slot was removedavailabilityId
availability.specific.createdA one-off availability override was createdavailabilityId
availability.specific.updatedA one-off availability override was updatedavailabilityId
availability.specific.removedA one-off availability override was removedavailabilityId