Events Overview
Detail of when specific events are triggered in the Ally platform
Appointments
The following events relates to the Appointment entity:
Event | Triggered when | Notes |
---|---|---|
appointment.created | When the Appointment is first created | This event only triggers once in the lifecycle of an appointment |
appointment.scheduled | When the Appointment has a valid windowId added to it | For Appointments created via the API or Dashboard this event may trigger very close to the appointment.created event |
appointment.updated | When the Appointment is updated | Certain Ally performed operational actions will cause this event to be triggered, even in some circumstances where the received payload does not change so this event should not be used to trigger messaging such as emails to external recipients |
appointment.completed | When the Appointment is completed by the Practitioner | This event only triggers once in the lifecycle of an appointment |
appointment.cancelled | When the Appointment is cancelled, or when Ally Operations updates the cancellation reason and related metadata |
Additional Events
If you wish to use additional events not listed on this page please contact Ally Support
Updated 11 months ago