{
  "appointment_client_confirmed": true,
  "appointment_created_at": "2024-01-23T10:00:00Z",
  "appointment_created_by": "John Smith",
  "appointment_date": "January 23, 2024",
  "appointment_datetime": "2024-01-23T10:00:00Z",
  "appointment_day_of_month": "23",
  "appointment_day_of_week": "Tuesday",
  "appointment_email_address": "patient@email.com",
  "appointment_end_datetime": "2024-01-23T11:30:00Z",
  "appointment_first_name": "John",
  "appointment_id": "12342",
  "appointment_last_name": "Smith",
  "appointment_length_minutes": 90,
  "appointment_location_detail": "Manhattan Office",
  "appointment_month": "January",
  "appointment_phone_number": "(222) 222-2222",
  "appointment_provider_email": "mariec@radioactiverus.com",
  "appointment_provider_full_name": "Marie Curie",
  "appointment_provider_id": "acbdefg",
  "appointment_status": "Confirmed",
  "appointment_time": "10:00AM",
  "appointment_type_id": "16f7f7e3-8df6-4eab-986d-d1fd8375926b",
  "appointment_type_title": "Initial Consultation",
  "appointment_zoom_meeting_password": "123456",
  "attendance_confirmation_response": "The confirmation response for the appt. (None, Confirmed, Cancelled)",
  "cancellation_reason_note": "Patient will reschedule next week",
  "cancelled_at": "2024-01-22T15:30:00Z",
  "client_note": "(905) 875-7338",
  "full_cancellation_reason": "Patient requested cancellation due to being cured",
  "intakeq_patient_id": "83212",
  "invoice_id": "65fdd9e89c7e50a54b3090ae",
  "invoice_number": 168,
  "last_updated_at": "2024-01-23T10:21:17Z",
  "practitioner_note": "Patient needs to complete intake form",
  "price": 150
}
{
  "appointment_client_confirmed": "Whether the appointment was booked/confirmed by the client",
  "appointment_created_at": "Time the appointment was created",
  "appointment_created_by": "Name of person who created the appointment",
  "appointment_date": "Full date of the appointment",
  "appointment_datetime": "Start time of the appointment",
  "appointment_day_of_month": "Day of month for the appointment",
  "appointment_day_of_week": "Day of week for the appointment",
  "appointment_email_address": "Email address of the client",
  "appointment_end_datetime": "End time of the appointment",
  "appointment_first_name": "Client's first name",
  "appointment_id": "Unique identifier for the appointment",
  "appointment_last_name": "Client's last name",
  "appointment_length_minutes": "Duration of appointment in minutes",
  "appointment_location_detail": "Location details - either physical location name or telehealth visit (e.g. Zoom) URL",
  "appointment_month": "Month of the appointment",
  "appointment_phone_number": "Phone number of the client",
  "appointment_provider_email": "Email address of the practitioner",
  "appointment_provider_full_name": "Full name of the practitioner",
  "appointment_provider_id": "ID of the practitioner",
  "appointment_status": "Status of the appointment",
  "appointment_time": "Time of the appointment in local timezone",
  "appointment_type_id": "Service ID for the appointment type",
  "appointment_type_title": "Name of the service/appointment type",
  "appointment_zoom_meeting_password": "Password for telehealth meeting if applicable",
  "attendance_confirmation_response": "Response to the attendance confirmation request",
  "cancellation_reason_note": "Additional notes about the cancellation",
  "cancelled_at": "If cancelled: when the appointment was cancelled",
  "client_note": "Client Note",
  "full_cancellation_reason": "Full reason for appointment cancellation",
  "intakeq_patient_id": "IntakeQ's unique identifier for the patient",
  "invoice_id": "ID of the invoice associated with the appointment",
  "invoice_number": "Invoice number associated with the appointment",
  "last_updated_at": "When the appointment was last updated",
  "practitioner_note": "Note provided by the practitioner",
  "price": "Price of the appointment (USD)"
}

Events

Triggering Webhook Types

The following event types are associated with the Appointment event payload from Intakeq.

  • Intakeq Appointment Scheduled
  • Intakeq Appointment Cancelled
  • Intakeq Appointment Confirmed
  • Intakeq Appointment Rescheduled
  • Intakeq Appointment Declined
  • Intakeq Appointment Missed
  • Intakeq Appointment Deleted
  • Intakeq Appointment Updated
  • Intakeq Appointment Assumed Occurred
{
  "appointment_client_confirmed": true,
  "appointment_created_at": "2024-01-23T10:00:00Z",
  "appointment_created_by": "John Smith",
  "appointment_date": "January 23, 2024",
  "appointment_datetime": "2024-01-23T10:00:00Z",
  "appointment_day_of_month": "23",
  "appointment_day_of_week": "Tuesday",
  "appointment_email_address": "patient@email.com",
  "appointment_end_datetime": "2024-01-23T11:30:00Z",
  "appointment_first_name": "John",
  "appointment_id": "12342",
  "appointment_last_name": "Smith",
  "appointment_length_minutes": 90,
  "appointment_location_detail": "Manhattan Office",
  "appointment_month": "January",
  "appointment_phone_number": "(222) 222-2222",
  "appointment_provider_email": "mariec@radioactiverus.com",
  "appointment_provider_full_name": "Marie Curie",
  "appointment_provider_id": "acbdefg",
  "appointment_status": "Confirmed",
  "appointment_time": "10:00AM",
  "appointment_type_id": "16f7f7e3-8df6-4eab-986d-d1fd8375926b",
  "appointment_type_title": "Initial Consultation",
  "appointment_zoom_meeting_password": "123456",
  "attendance_confirmation_response": "The confirmation response for the appt. (None, Confirmed, Cancelled)",
  "cancellation_reason_note": "Patient will reschedule next week",
  "cancelled_at": "2024-01-22T15:30:00Z",
  "client_note": "(905) 875-7338",
  "full_cancellation_reason": "Patient requested cancellation due to being cured",
  "intakeq_patient_id": "83212",
  "invoice_id": "65fdd9e89c7e50a54b3090ae",
  "invoice_number": 168,
  "last_updated_at": "2024-01-23T10:21:17Z",
  "practitioner_note": "Patient needs to complete intake form",
  "price": 150
}
{
  "appointment_client_confirmed": "Whether the appointment was booked/confirmed by the client",
  "appointment_created_at": "Time the appointment was created",
  "appointment_created_by": "Name of person who created the appointment",
  "appointment_date": "Full date of the appointment",
  "appointment_datetime": "Start time of the appointment",
  "appointment_day_of_month": "Day of month for the appointment",
  "appointment_day_of_week": "Day of week for the appointment",
  "appointment_email_address": "Email address of the client",
  "appointment_end_datetime": "End time of the appointment",
  "appointment_first_name": "Client's first name",
  "appointment_id": "Unique identifier for the appointment",
  "appointment_last_name": "Client's last name",
  "appointment_length_minutes": "Duration of appointment in minutes",
  "appointment_location_detail": "Location details - either physical location name or telehealth visit (e.g. Zoom) URL",
  "appointment_month": "Month of the appointment",
  "appointment_phone_number": "Phone number of the client",
  "appointment_provider_email": "Email address of the practitioner",
  "appointment_provider_full_name": "Full name of the practitioner",
  "appointment_provider_id": "ID of the practitioner",
  "appointment_status": "Status of the appointment",
  "appointment_time": "Time of the appointment in local timezone",
  "appointment_type_id": "Service ID for the appointment type",
  "appointment_type_title": "Name of the service/appointment type",
  "appointment_zoom_meeting_password": "Password for telehealth meeting if applicable",
  "attendance_confirmation_response": "Response to the attendance confirmation request",
  "cancellation_reason_note": "Additional notes about the cancellation",
  "cancelled_at": "If cancelled: when the appointment was cancelled",
  "client_note": "Client Note",
  "full_cancellation_reason": "Full reason for appointment cancellation",
  "intakeq_patient_id": "IntakeQ's unique identifier for the patient",
  "invoice_id": "ID of the invoice associated with the appointment",
  "invoice_number": "Invoice number associated with the appointment",
  "last_updated_at": "When the appointment was last updated",
  "practitioner_note": "Note provided by the practitioner",
  "price": "Price of the appointment (USD)"
}

Payload Field Details

Appointment
Event Payload