{ "appointment_confirmation_link": "URL to the appointment confirmation page", "appointment_created_at": "When the appointment was created", "appointment_created_by": "Email of the user who scheduled the appointment", "appointment_date": "Formatted date of the appointment", "appointment_datetime": "Start time of the appointment in UTC", "appointment_datetime_raw": "Raw datetime string from Acuity", "appointment_day_of_month": "Day of the month for the appointment", "appointment_day_of_week": "Day of the week for the appointment", "appointment_email_address": "Email address of the patient", "appointment_end_datetime": "End time of the appointment in UTC", "appointment_first_name": "Patient's first name", "appointment_id": "Unique identifier for the appointment", "appointment_last_name": "Patient's last name", "appointment_length_minutes": "Duration of the appointment in minutes", "appointment_location_detail": "Full Zoom meeting URL for the appointment", "appointment_month": "Month of the appointment", "appointment_notes": "Notes associated with the appointment", "appointment_patient_timezone_identifier": "IANA timezone identifier for the patient", "appointment_phone_number": "Patient's phone number", "appointment_provider_full_name": "Name of the provider's calendar", "appointment_provider_id": "ID of the provider's calendar", "appointment_time": "Formatted time of the appointment", "appointment_timezone_offset": "Timezone offset in ±HHMM format", "appointment_timezone_offset_seconds_east_of_utc": "Timezone offset in seconds east of UTC", "appointment_timezone_short_name": "Short name of the appointment timezone", "appointment_type": { "active": "Whether the appointment type is deleted (true = active, false = deleted)", "calendar_ids": "List of calendar IDs associated with this appointment type", "category": "The category of the appointment type", "description": "Optional description of the appointment type", "id": "Unique identifier for the appointment type", "length_minutes": "Duration of the appointment type in minutes", "minutes_padding_after": "The time padding after the appointment", "minutes_padding_before": "The time padding before the appointment", "name": "The name of the appointment type", "private": "Whether the appointment type is private", "scheduling_url": "URL for scheduling this appointment type" }, "appointment_type_id": "ID of the appointment type", "appointment_type_title": "Title of the appointment type", "appointment_zoom_meeting_id": "Zoom meeting ID extracted from location", "appointment_zoom_meeting_password": "Zoom meeting password extracted from location", "canceled": "Whether the appointment has been canceled", "customer_provided_id": "Customer-provided identifier (e.g. patient/morf profile ID)", "labels": "List of label names associated with the appointment"}
Acuity
Appointment
Event payload details and trigger documentation for Appointment data from Acuity
{ "appointment_confirmation_link": "URL to the appointment confirmation page", "appointment_created_at": "When the appointment was created", "appointment_created_by": "Email of the user who scheduled the appointment", "appointment_date": "Formatted date of the appointment", "appointment_datetime": "Start time of the appointment in UTC", "appointment_datetime_raw": "Raw datetime string from Acuity", "appointment_day_of_month": "Day of the month for the appointment", "appointment_day_of_week": "Day of the week for the appointment", "appointment_email_address": "Email address of the patient", "appointment_end_datetime": "End time of the appointment in UTC", "appointment_first_name": "Patient's first name", "appointment_id": "Unique identifier for the appointment", "appointment_last_name": "Patient's last name", "appointment_length_minutes": "Duration of the appointment in minutes", "appointment_location_detail": "Full Zoom meeting URL for the appointment", "appointment_month": "Month of the appointment", "appointment_notes": "Notes associated with the appointment", "appointment_patient_timezone_identifier": "IANA timezone identifier for the patient", "appointment_phone_number": "Patient's phone number", "appointment_provider_full_name": "Name of the provider's calendar", "appointment_provider_id": "ID of the provider's calendar", "appointment_time": "Formatted time of the appointment", "appointment_timezone_offset": "Timezone offset in ±HHMM format", "appointment_timezone_offset_seconds_east_of_utc": "Timezone offset in seconds east of UTC", "appointment_timezone_short_name": "Short name of the appointment timezone", "appointment_type": { "active": "Whether the appointment type is deleted (true = active, false = deleted)", "calendar_ids": "List of calendar IDs associated with this appointment type", "category": "The category of the appointment type", "description": "Optional description of the appointment type", "id": "Unique identifier for the appointment type", "length_minutes": "Duration of the appointment type in minutes", "minutes_padding_after": "The time padding after the appointment", "minutes_padding_before": "The time padding before the appointment", "name": "The name of the appointment type", "private": "Whether the appointment type is private", "scheduling_url": "URL for scheduling this appointment type" }, "appointment_type_id": "ID of the appointment type", "appointment_type_title": "Title of the appointment type", "appointment_zoom_meeting_id": "Zoom meeting ID extracted from location", "appointment_zoom_meeting_password": "Zoom meeting password extracted from location", "canceled": "Whether the appointment has been canceled", "customer_provided_id": "Customer-provided identifier (e.g. patient/morf profile ID)", "labels": "List of label names associated with the appointment"}
Events
Triggering Webhook Types
The following event types are associated with the Appointment event payload from Acuity.
{ "appointment_confirmation_link": "URL to the appointment confirmation page", "appointment_created_at": "When the appointment was created", "appointment_created_by": "Email of the user who scheduled the appointment", "appointment_date": "Formatted date of the appointment", "appointment_datetime": "Start time of the appointment in UTC", "appointment_datetime_raw": "Raw datetime string from Acuity", "appointment_day_of_month": "Day of the month for the appointment", "appointment_day_of_week": "Day of the week for the appointment", "appointment_email_address": "Email address of the patient", "appointment_end_datetime": "End time of the appointment in UTC", "appointment_first_name": "Patient's first name", "appointment_id": "Unique identifier for the appointment", "appointment_last_name": "Patient's last name", "appointment_length_minutes": "Duration of the appointment in minutes", "appointment_location_detail": "Full Zoom meeting URL for the appointment", "appointment_month": "Month of the appointment", "appointment_notes": "Notes associated with the appointment", "appointment_patient_timezone_identifier": "IANA timezone identifier for the patient", "appointment_phone_number": "Patient's phone number", "appointment_provider_full_name": "Name of the provider's calendar", "appointment_provider_id": "ID of the provider's calendar", "appointment_time": "Formatted time of the appointment", "appointment_timezone_offset": "Timezone offset in ±HHMM format", "appointment_timezone_offset_seconds_east_of_utc": "Timezone offset in seconds east of UTC", "appointment_timezone_short_name": "Short name of the appointment timezone", "appointment_type": { "active": "Whether the appointment type is deleted (true = active, false = deleted)", "calendar_ids": "List of calendar IDs associated with this appointment type", "category": "The category of the appointment type", "description": "Optional description of the appointment type", "id": "Unique identifier for the appointment type", "length_minutes": "Duration of the appointment type in minutes", "minutes_padding_after": "The time padding after the appointment", "minutes_padding_before": "The time padding before the appointment", "name": "The name of the appointment type", "private": "Whether the appointment type is private", "scheduling_url": "URL for scheduling this appointment type" }, "appointment_type_id": "ID of the appointment type", "appointment_type_title": "Title of the appointment type", "appointment_zoom_meeting_id": "Zoom meeting ID extracted from location", "appointment_zoom_meeting_password": "Zoom meeting password extracted from location", "canceled": "Whether the appointment has been canceled", "customer_provided_id": "Customer-provided identifier (e.g. patient/morf profile ID)", "labels": "List of label names associated with the appointment"}
Payload Field Details
Event Payload
Hide fields
string
required
Unique identifier for the appointment
CEL
appointment_id
Example
"1109810062"
string
Email address of the patient
CEL
appointment_email_address
Example
"example@test.com"
string
ID of the appointment type
CEL
appointment_type_id
Example
"38932233"
string
Title of the appointment type
CEL
appointment_type_title
Example
"Initial Visit"
object
Description coming soon
CEL
appointment_type
Example
{"active": true,"calendar_ids": ["7568038"],"category": "Consultations","description": "First consultation with a provider","id": "38932233","length_minutes": 30,"minutes_padding_after": 5,"minutes_padding_before": 5,"name": "Initial Visit","private": false,"scheduling_url": "https://app.acuityscheduling.com/schedule.php?owner=27553604"}
string
Unique identifier for the appointment type
CEL
appointment_type.id
Example
"38932233"
bool
Whether the appointment type is deleted (true = active, false = deleted)
CEL
appointment_type.active
Example
true
string
The name of the appointment type
CEL
appointment_type.name
Example
"Initial Visit"
string
Optional description of the appointment type
CEL
appointment_type.description
Example
"First consultation with a provider"
uint64
Duration of the appointment type in minutes
CEL
appointment_type.length_minutes
Example
30
string
The category of the appointment type
CEL
appointment_type.category
Example
"Consultations"
bool
Whether the appointment type is private
CEL
appointment_type.private
Example
false
uint64
The time padding before the appointment
CEL
appointment_type.minutes_padding_before
Example
5
uint64
The time padding after the appointment
CEL
appointment_type.minutes_padding_after
Example
5
[]string
List of calendar IDs associated with this appointment type