Parameters
Parameters
Hide parameters
Hide parameters
string
required
ID
This field maps to the destination API appointment_id field.{
"$result_object_key": {
"additional_clients": [
{
"client_id": 42,
"email_address": "ettore@bugatti.com",
"name": "Ettore Bugatti",
"phone_number": "5554016515"
}
],
"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_meeting_join_url": "https://example.com/meeting/123456",
"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",
"intake_id": "00000000-0000-0000-0000-000000000000",
"intakeq_patient_id": "83212",
"invitation": "Please join the video call using the link below: ....",
"invoice_id": "65fdd9e89c7e50a54b3090ae",
"invoice_number": 168,
"last_updated_at": "2024-01-23T10:21:17Z",
"practitioner_note": "Patient needs to complete intake form",
"price": 150
}
}
{
"$result_object_key": {
"additional_clients": {
"client_id": "IntakeQ's unique identifier for the client",
"email_address": "Email address of the client",
"name": "Full name of the client",
"phone_number": "Primary phone number of the client"
},
"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_meeting_join_url": "URL to join telehealth meeting if applicable",
"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",
"intake_id": "ID of the intake form associated with the appointment, if any",
"intakeq_patient_id": "IntakeQ's unique identifier for the patient",
"invitation": "Telehealth invitation text, may include the meeting link and password",
"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)"
}
}
Result Object Field Details
You can use the result of the action’s data as inputs to downstream workflow actions. Each fetch action requires an object name, which nests the action’s result data inside the downstream data context in the workflow. See Passing Data Between Actions for how to set it and reference the result from downstream nodes. Here we demonstrate how to refer to this data using the prefix$result_object_key.
Fetch Action Response Object
Hide fields
Hide fields
string
required
Unique identifier for the appointment
CEL
$result_object_key.appointment_id
Example
"12342"
string
required
Email address of the client
CEL
$result_object_key.appointment_email_address
Example
"patient@email.com"
string
required
Phone number of the client
CEL
$result_object_key.appointment_phone_number
Example
"(222) 222-2222"
string
required
Service ID for the appointment type
CEL
$result_object_key.appointment_type_id
Example
"16f7f7e3-8df6-4eab-986d-d1fd8375926b"
string
required
Name of the service/appointment type
CEL
$result_object_key.appointment_type_title
Example
"Initial Consultation"
bool
required
Whether the appointment was booked/confirmed by the client
CEL
$result_object_key.appointment_client_confirmed
Example
true
string
required
Location details - either physical location name or telehealth visit (e.g. Zoom) URL
CEL
$result_object_key.appointment_location_detail
Example
"Manhattan Office"
string
Password for telehealth meeting if applicable
CEL
$result_object_key.appointment_zoom_meeting_password
Example
"123456"
string
required
ID of the practitioner
CEL
$result_object_key.appointment_provider_id
Example
"acbdefg"
string
required
Full name of the practitioner
CEL
$result_object_key.appointment_provider_full_name
Example
"Marie Curie"
string
required
Email address of the practitioner
CEL
$result_object_key.appointment_provider_email
Example
"mariec@radioactiverus.com"
timing.v1.Timestamp
required
Start time of the appointment
CEL
$result_object_key.appointment_datetime
Example
"2024-01-23T10:00:00Z"
timing.v1.Timestamp
required
End time of the appointment
CEL
$result_object_key.appointment_end_datetime
Example
"2024-01-23T11:30:00Z"
uint64
required
Duration of appointment in minutes
CEL
$result_object_key.appointment_length_minutes
Example
90
timing.v1.Timestamp
required
Time the appointment was created
CEL
$result_object_key.appointment_created_at
Example
"2024-01-23T10:00:00Z"
string
required
Name of person who created the appointment
CEL
$result_object_key.appointment_created_by
Example
"John Smith"
string
required
Client’s first name
CEL
$result_object_key.appointment_first_name
Example
"John"
string
required
Client’s last name
CEL
$result_object_key.appointment_last_name
Example
"Smith"
string
required
Day of week for the appointment
CEL
$result_object_key.appointment_day_of_week
Example
"Tuesday"
string
required
Day of month for the appointment
CEL
$result_object_key.appointment_day_of_month
Example
"23"
string
required
Month of the appointment
CEL
$result_object_key.appointment_month
Example
"January"
string
required
Full date of the appointment
CEL
$result_object_key.appointment_date
Example
"January 23, 2024"
string
required
Time of the appointment in local timezone
CEL
$result_object_key.appointment_time
Example
"10:00AM"
string
required
Status of the appointment
CEL
$result_object_key.appointment_status
Example
"Confirmed"
string
required
IntakeQ’s unique identifier for the patient
CEL
$result_object_key.intakeq_patient_id
Example
"83212"
timing.v1.Timestamp
required
When the appointment was last updated
CEL
$result_object_key.last_updated_at
Example
"2024-01-23T10:21:17Z"
float64 (double)
Price of the appointment (USD)
CEL
$result_object_key.price
Example
150
string
ID of the invoice associated with the appointment
CEL
$result_object_key.invoice_id
Example
"65fdd9e89c7e50a54b3090ae"
int64
Invoice number associated with the appointment
CEL
$result_object_key.invoice_number
Example
168
string
Client Note
CEL
$result_object_key.client_note
Example
"(905) 875-7338"
string
Note provided by the practitioner
CEL
$result_object_key.practitioner_note
Example
"Patient needs to complete intake form"
string
Full reason for appointment cancellation
CEL
$result_object_key.full_cancellation_reason
Example
"Patient requested cancellation due to being cured"
string
Additional notes about the cancellation
CEL
$result_object_key.cancellation_reason_note
Example
"Patient will reschedule next week"
timing.v1.Timestamp
If cancelled: when the appointment was cancelled
CEL
$result_object_key.cancelled_at
Example
"2024-01-22T15:30:00Z"
string
Response to the attendance confirmation request
CEL
$result_object_key.attendance_confirmation_response
Example
"The confirmation response for the appt. (None, Confirmed, Cancelled)"
[]object
required
Additional clients associated with the appointment
CEL
$result_object_key.additional_clients
Example
[
{
"client_id": 42,
"email_address": "ettore@bugatti.com",
"name": "Ettore Bugatti",
"phone_number": "5554016515"
}
]
[]int64
required
Mapped array of: IntakeQ’s unique identifier for the client
CEL
$result_object_key.additional_clients.map(x, x.client_id)
Example
[
42
]
[]string
required
Mapped array of: Full name of the client
CEL
$result_object_key.additional_clients.map(x, x.name)
Example
[
"Ettore Bugatti"
]
[]string
required
Mapped array of: Email address of the client
CEL
$result_object_key.additional_clients.map(x, x.email_address)
Example
[
"ettore@bugatti.com"
]
[]string
required
Mapped array of: Primary phone number of the client
CEL
$result_object_key.additional_clients.map(x, x.phone_number)
Example
[
"5554016515"
]
string
Telehealth invitation text, may include the meeting link and password
CEL
$result_object_key.invitation
Example
"Please join the video call using the link below: ...."
string
URL to join telehealth meeting if applicable
CEL
$result_object_key.appointment_meeting_join_url
Example
"https://example.com/meeting/123456"
string
ID of the intake form associated with the appointment, if any
CEL
$result_object_key.intake_id
Example
"00000000-0000-0000-0000-000000000000"