Appointment
The Appointment component provides a user-friendly way for users to schedule appointments with your practice directly through your forms.
Before adding this component to your form, you must configure your appointment settings to define availability, staff, services, and other scheduling preferences.
See Appointment Settings Guide for details on how to set up and manage appointments.
How It Works
The Appointment component displays aseveral clickable input fields, allowing users to book their appointment selecting from elements such as the requested service, the location of said service, which worker they would like to book the appointment with, and the date and time of the appointment.
Properties
| Property | Description |
|---|---|
| Label Name | The text label displayed above the phone field. |
| Hide Label | Option to hide the label visually while keeping it accessible to screen readers. |
| Message | Error message that is shown when a user has failed to fill out and book an appointment. |
| Notification Presets | A collection of predefined email and SMS templates used to notify both the patient and internal team members. You can enable or disable specific notifications, and customize their content from the Appointment Settings > Notifications page. |
| Hide Location Map | Enable this setting to hide the map for selecting a location when scheduling an appointment. |
| Time Format | Choose whether time is displayed in AM/PM or 24 hour format. |
| Hide Time Zone Picker | Enable this setting to hide the time zone picker when scheduling an appointment. |
| Auto-schedule Appointment | The 'Schedule Appointment' button will be hidden, and appointments will be automatically scheduled upon form submission. |
| Enable Reminder | Allow users to choose whether they would like a reminder to be sent regarding their appointment. |
| Additional variables | Define additional variables that will influence how users can book appointments. |
| Location | Select which locations users will be able to choose from when booking they're appointment. For each location you can also define which workers are available, the schedule for that location, and which services that location offers. |
| Steps | Define the steps users will have to complete when booking their appointment. I.e. Select a service, then a location, then a worker, then click 'schedule appointment'. |
| Required contact information | Define whether specific contact information is required when booking an appointment. |
| Auto-fill from Field | You can prefill this field using values from existing form fields. |
| Phone | Enable to require users to provide their phone number when booking appointments. |
| Customizable Texts | Define which messages will be displayed in each field before a user has input any information. |
| Add CSS Class | Apply custom CSS classes to style the field to match your branding or layout. |
| Display Component in Navigation | Option to include this component in any summary or form navigation (if applicable). |
| Unique Name | A required identifier that must be unique within the form. Used in variables, email templates, webhooks, and integrations. |
| Variable Name | A variable identifier that can be copied to collect information in printable PDF or Word forms. |
| Mask in Notification Email | Masks the submitted value of this field in email notifications for enhanced privacy and compliance. Useful for preventing exposure of sensitive or identifiable information. |
Using Appointment Values in Other Parts of the Form
You can reference the provided appointment information elsewhere in the form (e.g., success pages, PDF templates, notification emails) using the component’s Unique Name as a variable.