Events
Triggering Webhook Types
The following event types are associated with the Appointment event payload from Acuity.Acuity Appointment ScheduledAcuity Appointment RescheduledAcuity Appointment CancelledAcuity Appointment UpdatedAcuity Appointment No Show
Copy
Ask AI
{
  "appointment_confirmation_link": "https://app.acuityscheduling.com/schedule.php?owner=27553604&action=appt&id%5B%5D=5e0e1d7ed20afe3834905c2813b7b6f0",
  "appointment_created_at": "2023-08-31T16:57:18Z",
  "appointment_created_by": "drlister@example.health",
  "appointment_date": "August 16, 2023",
  "appointment_datetime": "2023-08-16T17:45:00Z",
  "appointment_datetime_raw": "2023-08-16T10:45:00-0700",
  "appointment_day_of_month": "16",
  "appointment_day_of_week": "Wednesday",
  "appointment_email_address": "example@test.com",
  "appointment_end_datetime": "2023-08-16T18:15:00Z",
  "appointment_first_name": "John",
  "appointment_id": "1109810062",
  "appointment_last_name": "Doe",
  "appointment_length_minutes": 30,
  "appointment_location_detail": "https://us06web.zoom.us/j/81866002750?pwd=bHdvZ1dLaW5LSS80QUVTckE1ZU4wUT09",
  "appointment_month": "August",
  "appointment_notes": "This is a note that could be empty",
  "appointment_patient_timezone_identifier": "America/Los_Angeles",
  "appointment_phone_number": "7083799999",
  "appointment_provider_full_name": "Joseph Lister",
  "appointment_provider_id": "7568038",
  "appointment_time": "10:45am",
  "appointment_timezone_offset": "-0700",
  "appointment_timezone_offset_seconds_east_of_utc": -25200,
  "appointment_timezone_short_name": "PDT",
  "appointment_type": {
    "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"
  },
  "appointment_type_id": "38932233",
  "appointment_type_title": "Initial Visit",
  "appointment_zoom_meeting_id": "81866002750",
  "appointment_zoom_meeting_password": "234508",
  "canceled": false,
  "customer_provided_id": "a2bb52cb-7dc7-4710-902b-245efb55ef9e",
  "labels": "number1"
}
Copy
Ask AI
{
  "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
Hide fields
Hide fields
Unique identifier for the appointment
CEL
Copy
Ask AI
appointment_id
Example
Copy
Ask AI
"1109810062"
Email address of the patient
CEL
Copy
Ask AI
appointment_email_address
Example
Copy
Ask AI
"example@test.com"
ID of the appointment type
CEL
Copy
Ask AI
appointment_type_id
Example
Copy
Ask AI
"38932233"
Title of the appointment type
CEL
Copy
Ask AI
appointment_type_title
Example
Copy
Ask AI
"Initial Visit"
Description coming soon
CEL
Copy
Ask AI
appointment_type
Example
Copy
Ask AI
{
"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"
}
Unique identifier for the appointment type
CEL
Copy
Ask AI
appointment_type.id
Example
Copy
Ask AI
"38932233"
Whether the appointment type is deleted (true = active, false = deleted)
CEL
Copy
Ask AI
appointment_type.active
Example
Copy
Ask AI
true
The name of the appointment type
CEL
Copy
Ask AI
appointment_type.name
Example
Copy
Ask AI
"Initial Visit"
Optional description of the appointment type
CEL
Copy
Ask AI
appointment_type.description
Example
Copy
Ask AI
"First consultation with a provider"
Duration of the appointment type in minutes
CEL
Copy
Ask AI
appointment_type.length_minutes
Example
Copy
Ask AI
30
The category of the appointment type
CEL
Copy
Ask AI
appointment_type.category
Example
Copy
Ask AI
"Consultations"
Whether the appointment type is private
CEL
Copy
Ask AI
appointment_type.private
Example
Copy
Ask AI
false
The time padding before the appointment
CEL
Copy
Ask AI
appointment_type.minutes_padding_before
Example
Copy
Ask AI
5
The time padding after the appointment
CEL
Copy
Ask AI
appointment_type.minutes_padding_after
Example
Copy
Ask AI
5
List of calendar IDs associated with this appointment type
CEL
Copy
Ask AI
appointment_type.calendar_ids
Example
Copy
Ask AI
[
"7568038"
]
URL for scheduling this appointment type
CEL
Copy
Ask AI
appointment_type.scheduling_url
Example
Copy
Ask AI
"https://app.acuityscheduling.com/schedule.php?owner=27553604"
Full Zoom meeting URL for the appointment
CEL
Copy
Ask AI
appointment_location_detail
Example
Copy
Ask AI
"https://us06web.zoom.us/j/81866002750?pwd=bHdvZ1dLaW5LSS80QUVTckE1ZU4wUT09"
Zoom meeting ID extracted from location
CEL
Copy
Ask AI
appointment_zoom_meeting_id
Example
Copy
Ask AI
"81866002750"
Zoom meeting password extracted from location
CEL
Copy
Ask AI
appointment_zoom_meeting_password
Example
Copy
Ask AI
"234508"
ID of the provider’s calendar
CEL
Copy
Ask AI
appointment_provider_id
Example
Copy
Ask AI
"7568038"
Name of the provider’s calendar
CEL
Copy
Ask AI
appointment_provider_full_name
Example
Copy
Ask AI
"Joseph Lister"
Raw datetime string from Acuity
CEL
Copy
Ask AI
appointment_datetime_raw
Example
Copy
Ask AI
"2023-08-16T10:45:00-0700"
Start time of the appointment in UTC
CEL
Copy
Ask AI
appointment_datetime
Example
Copy
Ask AI
"2023-08-16T17:45:00Z"
End time of the appointment in UTC
CEL
Copy
Ask AI
appointment_end_datetime
Example
Copy
Ask AI
"2023-08-16T18:15:00Z"
Duration of the appointment in minutes
CEL
Copy
Ask AI
appointment_length_minutes
Example
Copy
Ask AI
30
Notes associated with the appointment
CEL
Copy
Ask AI
appointment_notes
Example
Copy
Ask AI
"This is a note that could be empty"
When the appointment was created
CEL
Copy
Ask AI
appointment_created_at
Example
Copy
Ask AI
"2023-08-31T16:57:18Z"
Email of the user who scheduled the appointment
CEL
Copy
Ask AI
appointment_created_by
Example
Copy
Ask AI
"drlister@example.health"
Short name of the appointment timezone
CEL
Copy
Ask AI
appointment_timezone_short_name
Example
Copy
Ask AI
"PDT"
Timezone offset in ±HHMM format
CEL
Copy
Ask AI
appointment_timezone_offset
Example
Copy
Ask AI
"-0700"
Timezone offset in seconds east of UTC
CEL
Copy
Ask AI
appointment_timezone_offset_seconds_east_of_utc
Example
Copy
Ask AI
-25200
IANA timezone identifier for the patient
CEL
Copy
Ask AI
appointment_patient_timezone_identifier
Example
Copy
Ask AI
"America/Los_Angeles"
URL to the appointment confirmation page
CEL
Copy
Ask AI
appointment_confirmation_link
Example
Copy
Ask AI
"https://app.acuityscheduling.com/schedule.php?owner=27553604&action=appt&id%5B%5D=5e0e1d7ed20afe3834905c2813b7b6f0"
Patient’s first name
CEL
Copy
Ask AI
appointment_first_name
Example
Copy
Ask AI
"John"
Patient’s last name
CEL
Copy
Ask AI
appointment_last_name
Example
Copy
Ask AI
"Doe"
Day of the week for the appointment
CEL
Copy
Ask AI
appointment_day_of_week
Example
Copy
Ask AI
"Wednesday"
Day of the month for the appointment
CEL
Copy
Ask AI
appointment_day_of_month
Example
Copy
Ask AI
"16"
Month of the appointment
CEL
Copy
Ask AI
appointment_month
Example
Copy
Ask AI
"August"
Formatted date of the appointment
CEL
Copy
Ask AI
appointment_date
Example
Copy
Ask AI
"August 16, 2023"
Formatted time of the appointment
CEL
Copy
Ask AI
appointment_time
Example
Copy
Ask AI
"10:45am"
Patient’s phone number
CEL
Copy
Ask AI
appointment_phone_number
Example
Copy
Ask AI
"7083799999"
Customer-provided identifier (e.g. patient/morf profile ID)
CEL
Copy
Ask AI
customer_provided_id
Example
Copy
Ask AI
"a2bb52cb-7dc7-4710-902b-245efb55ef9e"
List of label names associated with the appointment
CEL
Copy
Ask AI
labels
Example
Copy
Ask AI
"number1"
Whether the appointment has been canceled
CEL
Copy
Ask AI
canceled
Example
Copy
Ask AI
false
