Availability events
New Appointment System
These events only apply to practices using the New Semble Appointment System.
| Event type | Description | Identifiers |
|---|---|---|
resourceAvailability.created | An availability or unavailability rule was created. Fetch the rule with availabilityRule. | resourceAvailabilityId |
resourceAvailability.updated | An availability or unavailability rule was updated, including when a single day is excluded or a recurring rule is split. Fetch the rule with availabilityRule. | resourceAvailabilityId |
resourceAvailability.deleted | An availability or unavailability rule was deleted. availabilityRule does not return the rule after this event. | resourceAvailabilityId |
Legacy Appointment System
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 type | Description | Identifiers |
|---|---|---|
availability.blocker.created | A calendar blocker was created | availabilityId or bookingId; optional patientId, doctorId (booking blockers only) |
availability.blocker.updated | A calendar blocker was updated | Same as availability.blocker.created |
availability.blocker.removed | A calendar blocker was removed | Same as availability.blocker.created |
availability.recurring.created | A recurring weekly availability slot was created | availabilityId |
availability.recurring.updated | A recurring weekly availability slot was updated | availabilityId |
availability.recurring.removed | A recurring weekly availability slot was removed | availabilityId |
availability.specific.created | A one-off availability override was created | availabilityId |
availability.specific.updated | A one-off availability override was updated | availabilityId |
availability.specific.removed | A one-off availability override was removed | availabilityId |