Events
Triggering Webhook Types
The following event types are associated with the Appointment event payload from Healthie.Healthie Appointment Scheduled
Healthie Appointment Updated
Healthie Appointment Marked Occurred
Healthie Appointment No Show
Healthie Appointment Rescheduled
Healthie Appointment Cancelled
Copy
Ask AI
{
"actual_duration_minutes": 42,
"add_to_ical_link": "https://app.gethealthie.com/appointments/add_to_cal/12345678.ics?cal_export_id=Dac9JLS9Qas1PURwBcX7",
"appointment_add_to_cal_link": "https://calendar.google.com/calendar/render?action=TEMPLATE&text=Intake+Appointment&dates=20240701T193000Z/20240701T204500Z&details=https%3A%2F%2Fsecurestaging.gethealthie.com%2Fappointments%2F597220%3Frel_appt_id%3D597220%26rel_appt_date%3D2024-07-01%252012%3A30%3A00%2520-0700&location=https%3A%2F%2Fsecurestaging.gethealthie.com%2Fappointments%2F597220%3Frel_appt_id%3D597220%26rel_appt_date%3D2024-07-01%252012%3A30%3A00%2520-0700",
"appointment_client_confirmed": true,
"appointment_created_at": "2024-07-08T17:12:11Z",
"appointment_created_by": "Test Patient",
"appointment_date": "July 12, 2024",
"appointment_datetime": "2024-07-12T15:00:00Z",
"appointment_datetime_raw": "Friday, Jul 12 2024, 10:00AM -0400",
"appointment_day_of_month": "12th",
"appointment_day_of_week": "Friday",
"appointment_deleted_at": "2024-07-18T12:19:19Z",
"appointment_email_address": "patientzero@healthcare.org",
"appointment_end_datetime": "2024-07-12T16:00:00Z",
"appointment_first_name": "Test",
"appointment_id": "597220",
"appointment_is_blocker": false,
"appointment_last_name": "Test",
"appointment_legal_name": "Test Patient",
"appointment_length_minutes": 60,
"appointment_location_detail": "https://zoom.us/j/97162458155?pwd=VMNDqvql2fTLwxZjjpkQmtwSVX9jbu.1",
"appointment_location_label": "Secure Videochat",
"appointment_location_type": "Secure Videochat",
"appointment_metadata": null,
"appointment_month": "July",
"appointment_notes": "Patient needs a vaccination for vacation to the tropics",
"appointment_patient_timezone_identifier": "America/New_York",
"appointment_phone_number": "+15551234123",
"appointment_provider_confirmed": true,
"appointment_provider_email": "lister@vaccinesrus.org",
"appointment_provider_full_name": "Dr. Edward Lister",
"appointment_provider_id": "4609771",
"appointment_reason": "Intake visit for first vaccine",
"appointment_status": "Re-Scheduled",
"appointment_status_changed_at": "2024-07-11T12:11:04Z",
"appointment_time": "10:00AM",
"appointment_timezone_offset": "-04:00",
"appointment_timezone_offset_seconds_east_of_utc": -14400,
"appointment_timezone_short_name": "EDT",
"appointment_type": {
"associated_provider_names": [
"Dr. Alexander Fleming",
"Dr. Howard Florey",
"Dr. Ernst Chain"
],
"deleted_at": "2024-09-10T11:01:02Z",
"id": "201091",
"length_minutes": 60,
"name": "Intake Session",
"user_group_id": "126642"
},
"appointment_type_id": "58923",
"appointment_type_title": "Intake Appointment",
"appointment_updated_at": "2024-07-11T12:11:04Z",
"appointment_zoom_meeting_id": "97162458155",
"attendee_user_ids": [
"42314",
"200023"
],
"changed_fields": [
"start",
"pm_status"
],
"connected_chart_note_locked": false,
"connected_chart_note_string": "Not Written",
"current_position_in_recurring_series": 1,
"dietician_organization_id": "123450",
"dietitian_email_address": "drfleming@example.com",
"dietitian_first_name": "Alexander",
"dietitian_id": "100070",
"dietitian_last_name": "Fleming",
"dietitian_organization_id": "123450",
"form_answer_group_id": "30082312",
"group_appointment_user_groups": [
{
"created_at": "2024-07-01T11:29:19+00:00",
"id": "123012",
"name": "Intake"
}
],
"healthie_patient_id": "1299482",
"healthie_patient_record_identifier": "d7650d13-f865-1d52-8bfa-7b851e366a3d",
"is_group_appointment": false,
"last_updated_by_id": "400022",
"status_last_updated_by_id": "123456"
}
Copy
Ask AI
{
"actual_duration_minutes": "Actual length of the Appointment (that occurred / time elapsed)",
"add_to_ical_link": "Link to download an ICS file and add this Appointment to your calendar",
"appointment_add_to_cal_link": "Link to add the Appointment to a calendar",
"appointment_client_confirmed": "Whether or not the Patient has confirmed the Appointment",
"appointment_created_at": "Appointment created at time",
"appointment_created_by": "Appointment creator name",
"appointment_date": "Month of the Appointment",
"appointment_datetime": "Appointment start time (UTC time)",
"appointment_datetime_raw": "Raw Healthie timestamp for the Appointment `start`",
"appointment_day_of_month": "Day (ordinal) of the month of the Appointment",
"appointment_day_of_week": "Day of the week of the Appointment",
"appointment_deleted_at": "Appointment deleted at time",
"appointment_email_address": "Patient's email address",
"appointment_end_datetime": "Appointment end time (UTC time)",
"appointment_first_name": "Patient's first name",
"appointment_id": "ID of the Appointment",
"appointment_is_blocker": "Is the Appointment a calendar block",
"appointment_last_name": "Patient's last name",
"appointment_legal_name": "Legal name of the Patient",
"appointment_length_minutes": "Appointment length in minutes",
"appointment_location_detail": "Details of the Appointment location",
"appointment_location_label": "Label for the Appointment location (e.g., Secure Videochat)",
"appointment_location_type": "Type of the Appointment location (e.g., Secure Videochat)",
"appointment_metadata": null,
"appointment_month": "Month of the Appointment",
"appointment_notes": "Appointment notes",
"appointment_patient_timezone_identifier": "Patient's registered Healthie timezone ISO identifier",
"appointment_phone_number": "Patient's phone number",
"appointment_provider_confirmed": "Whether or not the Provider has confirmed the Appointment",
"appointment_provider_email": "Email address of the Appointment Provider",
"appointment_provider_full_name": "Full name of the Appointment Provider",
"appointment_provider_id": "ID of the Appointment Provider",
"appointment_reason": "Reason for the Appointment",
"appointment_status": "Appointment status",
"appointment_status_changed_at": "Appointment status update time",
"appointment_time": "Time of the Appointment (in the Appointment's registered timezone)",
"appointment_timezone_offset": "Appointment timezone offset",
"appointment_timezone_offset_seconds_east_of_utc": "Appointment timezone offset in seconds east of the Greenwich meridian",
"appointment_timezone_short_name": "Appointment timezone short name",
"appointment_type": {
"associated_provider_names": "List of associated providers for the Appointment Type",
"deleted_at": "Timestamp when the Appointment Type was deleted",
"id": "ID of the Appointment Type",
"length_minutes": "Length of the standard Appointment of this Type in minutes",
"name": "Name of the Appointment Type",
"user_group_id": "ID of the User Group associated with the Appointment Type"
},
"appointment_type_id": "ID of the Appointment Type",
"appointment_type_title": "Appointment type title",
"appointment_updated_at": "Appointment updated at time",
"appointment_zoom_meeting_id": "ID of the Zoom meeting associated with the Appointment",
"attendee_user_ids": "The user IDs of all the attendees scheduled to be at the Appointment, or those who did attend if marked occurred",
"changed_fields": "Healthie Appointment object fields changed in triggering the event for this Appointment",
"connected_chart_note_locked": "Is the connected Chart Note locked?",
"connected_chart_note_string": "Connected Chart Note string",
"current_position_in_recurring_series": "The position of the appointment in the recurring series (only specified if it's a recurring appointment)",
"dietician_organization_id": "Organization ID for the Patient's registered dietitian",
"dietitian_email_address": "Email address of the Patient's registered dietitian",
"dietitian_first_name": "First name of the Patient's registered dietitian",
"dietitian_id": "ID of the Patient's registered dietitian",
"dietitian_last_name": "Last name of the Patient's registered dietitian",
"dietitian_organization_id": "Organization ID for the Patient's registered dietitian",
"form_answer_group_id": "The ID of the first form answer group associated with the Appointment",
"group_appointment_user_groups": {
"created_at": "When the User Group was created",
"id": "ID of the User Group",
"name": "Name of the User Group"
},
"healthie_patient_id": "ID of the Patient (User) for the Appointment",
"healthie_patient_record_identifier": "Patient record_identifier (Morf Profile ID)",
"is_group_appointment": "Whether this appointment was scheduled for a group of patients",
"last_updated_by_id": "User ID for the last person to update the Appointment",
"status_last_updated_by_id": "User ID for the last person to update the Appointment status"
}
Payload Field Details
Hide fields
Hide fields
ID of the Appointment
CEL
Copy
Ask AI
appointment_id
Example
Copy
Ask AI
"597220"
ID
ID of the Patient (User) for the AppointmentCEL
Copy
Ask AI
healthie_patient_id
Example
Copy
Ask AI
"1299482"
ID of the Appointment Type
CEL
Copy
Ask AI
appointment_type_id
Example
Copy
Ask AI
"58923"
Appointment type title
CEL
Copy
Ask AI
appointment_type_title
Example
Copy
Ask AI
"Intake Appointment"
Whether or not the Provider has confirmed the Appointment
CEL
Copy
Ask AI
appointment_provider_confirmed
Example
Copy
Ask AI
true
Whether or not the Patient has confirmed the Appointment
CEL
Copy
Ask AI
appointment_client_confirmed
Example
Copy
Ask AI
true
Link to add the Appointment to a calendar
CEL
Copy
Ask AI
appointment_add_to_cal_link
Example
Copy
Ask AI
"https://calendar.google.com/calendar/render?action=TEMPLATE&text=Intake+Appointment&dates=20240701T193000Z/20240701T204500Z&details=https%3A%2F%2Fsecurestaging.gethealthie.com%2Fappointments%2F597220%3Frel_appt_id%3D597220%26rel_appt_date%3D2024-07-01%252012%3A30%3A00%2520-0700&location=https%3A%2F%2Fsecurestaging.gethealthie.com%2Fappointments%2F597220%3Frel_appt_id%3D597220%26rel_appt_date%3D2024-07-01%252012%3A30%3A00%2520-0700"
Label for the Appointment location (e.g., Secure Videochat)
CEL
Copy
Ask AI
appointment_location_label
Example
Copy
Ask AI
"Secure Videochat"
Type of the Appointment location (e.g., Secure Videochat)
CEL
Copy
Ask AI
appointment_location_type
Example
Copy
Ask AI
"Secure Videochat"
Details of the Appointment location
CEL
Copy
Ask AI
appointment_location_detail
Example
Copy
Ask AI
"https://zoom.us/j/97162458155?pwd=VMNDqvql2fTLwxZjjpkQmtwSVX9jbu.1"
ID of the Zoom meeting associated with the Appointment
CEL
Copy
Ask AI
appointment_zoom_meeting_id
Example
Copy
Ask AI
"97162458155"
ID of the Appointment Provider
CEL
Copy
Ask AI
appointment_provider_id
Example
Copy
Ask AI
"4609771"
Full name of the Appointment Provider
CEL
Copy
Ask AI
appointment_provider_full_name
Example
Copy
Ask AI
"Dr. Edward Lister"
Email address of the Appointment Provider
CEL
Copy
Ask AI
appointment_provider_email
Example
Copy
Ask AI
"lister@vaccinesrus.org"
Reason for the Appointment
CEL
Copy
Ask AI
appointment_reason
Example
Copy
Ask AI
"Intake visit for first vaccine"
Raw Healthie timestamp for the Appointment
start
CEL
Copy
Ask AI
appointment_datetime_raw
Example
Copy
Ask AI
"Friday, Jul 12 2024, 10:00AM -0400"
Appointment start time (UTC time)
CEL
Copy
Ask AI
appointment_datetime
Example
Copy
Ask AI
"2024-07-12T15:00:00Z"
Appointment end time (UTC time)
CEL
Copy
Ask AI
appointment_end_datetime
Example
Copy
Ask AI
"2024-07-12T16:00:00Z"
Appointment length in minutes
CEL
Copy
Ask AI
appointment_length_minutes
Example
Copy
Ask AI
60
Appointment status
CEL
Copy
Ask AI
appointment_status
Example
Copy
Ask AI
"Re-Scheduled"
Appointment status update time
CEL
Copy
Ask AI
appointment_status_changed_at
Example
Copy
Ask AI
"2024-07-11T12:11:04Z"
HI
PII
Appointment notesCEL
Copy
Ask AI
appointment_notes
Example
Copy
Ask AI
"Patient needs a vaccination for vacation to the tropics"
Appointment created at time
CEL
Copy
Ask AI
appointment_created_at
Example
Copy
Ask AI
"2024-07-08T17:12:11Z"
Appointment updated at time
CEL
Copy
Ask AI
appointment_updated_at
Example
Copy
Ask AI
"2024-07-11T12:11:04Z"
Appointment deleted at time
CEL
Copy
Ask AI
appointment_deleted_at
Example
Copy
Ask AI
"2024-07-18T12:19:19Z"
Appointment creator name
CEL
Copy
Ask AI
appointment_created_by
Example
Copy
Ask AI
"Test Patient"
Appointment timezone short name
CEL
Copy
Ask AI
appointment_timezone_short_name
Example
Copy
Ask AI
"EDT"
Appointment timezone offset
CEL
Copy
Ask AI
appointment_timezone_offset
Example
Copy
Ask AI
"-04:00"
Appointment timezone offset in seconds east of the Greenwich meridian
CEL
Copy
Ask AI
appointment_timezone_offset_seconds_east_of_utc
Example
Copy
Ask AI
-14400
Patient’s registered Healthie timezone ISO identifier
CEL
Copy
Ask AI
appointment_patient_timezone_identifier
Example
Copy
Ask AI
"America/New_York"
ID
Patient record_identifier (Morf Profile ID)CEL
Copy
Ask AI
healthie_patient_record_identifier
Example
Copy
Ask AI
"d7650d13-f865-1d52-8bfa-7b851e366a3d"
Is the Appointment a calendar block
CEL
Copy
Ask AI
appointment_is_blocker
Example
Copy
Ask AI
false
Appointment Type information
CEL
Copy
Ask AI
appointment_type
Example
Copy
Ask AI
{
"associated_provider_names": [
"Dr. Alexander Fleming",
"Dr. Howard Florey",
"Dr. Ernst Chain"
],
"deleted_at": "2024-09-10T11:01:02Z",
"id": "201091",
"length_minutes": 60,
"name": "Intake Session",
"user_group_id": "126642"
}
ID of the Appointment Type
CEL
Copy
Ask AI
appointment_type.id
Example
Copy
Ask AI
"201091"
Name of the Appointment Type
CEL
Copy
Ask AI
appointment_type.name
Example
Copy
Ask AI
"Intake Session"
Length of the standard Appointment of this Type in minutes
CEL
Copy
Ask AI
appointment_type.length_minutes
Example
Copy
Ask AI
60
ID of the User Group associated with the Appointment Type
CEL
Copy
Ask AI
appointment_type.user_group_id
Example
Copy
Ask AI
"126642"
List of associated providers for the Appointment Type
CEL
Copy
Ask AI
appointment_type.associated_provider_names
Example
Copy
Ask AI
[
"Dr. Alexander Fleming",
"Dr. Howard Florey",
"Dr. Ernst Chain"
]
Timestamp when the Appointment Type was deleted
CEL
Copy
Ask AI
appointment_type.deleted_at
Example
Copy
Ask AI
"2024-09-10T11:01:02Z"
Day of the week of the Appointment
CEL
Copy
Ask AI
appointment_day_of_week
Example
Copy
Ask AI
"Friday"
Day (ordinal) of the month of the Appointment
CEL
Copy
Ask AI
appointment_day_of_month
Example
Copy
Ask AI
"12th"
Month of the Appointment
CEL
Copy
Ask AI
appointment_month
Example
Copy
Ask AI
"July"
Month of the Appointment
CEL
Copy
Ask AI
appointment_date
Example
Copy
Ask AI
"July 12, 2024"
Time of the Appointment (in the Appointment’s registered timezone)
CEL
Copy
Ask AI
appointment_time
Example
Copy
Ask AI
"10:00AM"
PII
Patient’s email addressCEL
Copy
Ask AI
appointment_email_address
Example
Copy
Ask AI
"patientzero@healthcare.org"
PII
Patient’s first nameCEL
Copy
Ask AI
appointment_first_name
Example
Copy
Ask AI
"Test"
PII
Patient’s last nameCEL
Copy
Ask AI
appointment_last_name
Example
Copy
Ask AI
"Test"
PII
Patient’s phone numberCEL
Copy
Ask AI
appointment_phone_number
Example
Copy
Ask AI
"+15551234123"
Organization ID for the Patient’s registered dietitian
CEL
Copy
Ask AI
dietician_organization_id
Example
Copy
Ask AI
"123450"
Organization ID for the Patient’s registered dietitian
CEL
Copy
Ask AI
dietitian_organization_id
Example
Copy
Ask AI
"123450"
First name of the Patient’s registered dietitian
CEL
Copy
Ask AI
dietitian_first_name
Example
Copy
Ask AI
"Alexander"
Last name of the Patient’s registered dietitian
CEL
Copy
Ask AI
dietitian_last_name
Example
Copy
Ask AI
"Fleming"
Email address of the Patient’s registered dietitian
CEL
Copy
Ask AI
dietitian_email_address
Example
Copy
Ask AI
"drfleming@example.com"
ID of the Patient’s registered dietitian
CEL
Copy
Ask AI
dietitian_id
Example
Copy
Ask AI
"100070"
Description coming soon
CEL
Copy
Ask AI
appointment_metadata
Example
Copy
Ask AI
null
Actual length of the Appointment (that occurred / time elapsed)
CEL
Copy
Ask AI
actual_duration_minutes
Example
Copy
Ask AI
42
ID
User ID for the last person to update the AppointmentCEL
Copy
Ask AI
last_updated_by_id
Example
Copy
Ask AI
"400022"
Is the connected Chart Note locked?
CEL
Copy
Ask AI
connected_chart_note_locked
Example
Copy
Ask AI
false
Connected Chart Note string
CEL
Copy
Ask AI
connected_chart_note_string
Example
Copy
Ask AI
"Not Written"
User ID for the last person to update the Appointment status
CEL
Copy
Ask AI
status_last_updated_by_id
Example
Copy
Ask AI
"123456"
Link to download an ICS file and add this Appointment to your calendar
CEL
Copy
Ask AI
add_to_ical_link
Example
Copy
Ask AI
"https://app.gethealthie.com/appointments/add_to_cal/12345678.ics?cal_export_id=Dac9JLS9Qas1PURwBcX7"
PII
Legal name of the PatientCEL
Copy
Ask AI
appointment_legal_name
Example
Copy
Ask AI
"Test Patient"
Healthie Appointment object fields changed in triggering the event for this Appointment
CEL
Copy
Ask AI
changed_fields
Example
Copy
Ask AI
[
"start",
"pm_status"
]
Whether this appointment was scheduled for a group of patients
CEL
Copy
Ask AI
is_group_appointment
Example
Copy
Ask AI
false
The user IDs of all the attendees scheduled to be at the Appointment, or those who did attend if marked occurred
CEL
Copy
Ask AI
attendee_user_ids
Example
Copy
Ask AI
[
"42314",
"200023"
]
If the Appointment is a group appointment, the user groups this Appointment was scheduled for
CEL
Copy
Ask AI
group_appointment_user_groups
Example
Copy
Ask AI
[
{
"created_at": "2024-07-01T11:29:19+00:00",
"id": "123012",
"name": "Intake"
}
]
Mapped array of: ID of the User Group
CEL
Copy
Ask AI
group_appointment_user_groups.map(x, x.id)
Example
Copy
Ask AI
[
"123012"
]
Mapped array of: Name of the User Group
CEL
Copy
Ask AI
group_appointment_user_groups.map(x, x.name)
Example
Copy
Ask AI
[
"Intake"
]
Mapped array of: When the User Group was created
CEL
Copy
Ask AI
group_appointment_user_groups.map(x, x.created_at)
Example
Copy
Ask AI
[
"2024-07-01T11:29:19+00:00"
]
The position of the appointment in the recurring series (only specified if it’s a recurring appointment)
CEL
Copy
Ask AI
current_position_in_recurring_series
Example
Copy
Ask AI
1
The ID of the first form answer group associated with the Appointment
CEL
Copy
Ask AI
form_answer_group_id
Example
Copy
Ask AI
"30082312"