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