Events
Triggering Webhook Types
The following event types are associated with the Note event payload from Intakeq.Intakeq Note LockedIntakeq Note Updated
{
"appointment_id": "54683513554",
"client_email": "john.doe@example.com",
"client_id": 12345,
"client_name": "John Doe",
"id": "note123",
"last_modified_at": "2023-01-15T14:30:00Z",
"note_name": "Initial Assessment",
"practitioner_email": "doctor@example.com",
"practitioner_id": "pract456",
"practitioner_name": "Dr. Jane Smith",
"questions": [
{
"answer": "Back pain",
"attachments": [
{
"content_type": "application/pdf",
"file_name": "medical_report.pdf",
"id": "12342",
"url": "https://example.com/attachment.pdf"
}
],
"client_profile_field_id": "primary_concern",
"column_names": [
"Symptom",
"Severity"
],
"id": "12342",
"office_note": "Patient reported severe pain",
"office_use": false,
"question_type": "text",
"rows": [
{
"answers": [
"Back pain",
"Severe"
],
"text": "Back pain"
}
],
"text": "What is your primary concern?"
}
],
"status": "locked or unlocked",
"timestamp": "2023-01-15T14:30:00Z"
}
{
"appointment_id": "Identifier of the associated appointment",
"client_email": "Email address of the client",
"client_id": "Unique identifier for the client",
"client_name": "Name of the client",
"id": "Unique identifier for the note",
"last_modified_at": "Timestamp when the note was last modified",
"note_name": "Name of the note",
"practitioner_email": "Email of the practitioner",
"practitioner_id": "Unique identifier for the practitioner",
"practitioner_name": "Name of the practitioner",
"questions": {
"answer": "Answer to the question",
"attachments": {
"content_type": "Content type of the attachment",
"file_name": "Name of the attached file",
"id": "Unique identifier for the attachment",
"url": "URL of the attachment"
},
"client_profile_field_id": "ID of the client profile field this question maps to",
"column_names": "Column names for table/grid questions",
"id": "Unique identifier for the question",
"office_note": "Office note for the question",
"office_use": "Whether the question is for office use only",
"question_type": "Type of the question",
"rows": {
"answers": "Answers for each column in the row",
"text": "Text for the row"
},
"text": "Text of the question"
},
"status": "Status of the note",
"timestamp": "Timestamp when the note was created (called `Date` in the IntakeQ API)"
}
Payload Field Details
Event Payload
Hide fields
Hide fields
string
required
Unique identifier for the note
CEL
id
Example
"note123"
string
Name of the client
CEL
client_name
Example
"John Doe"
string
Email address of the client
CEL
client_email
Example
"john.doe@example.com"
int64
required
Unique identifier for the client
CEL
client_id
Example
12345
string
required
Status of the note
CEL
status
Example
"locked or unlocked"
timing.v1.Timestamp
required
Timestamp when the note was created (called
Date in the IntakeQ API)CEL
timestamp
Example
"2023-01-15T14:30:00Z"
string
Name of the note
CEL
note_name
Example
"Initial Assessment"
string
Email of the practitioner
CEL
practitioner_email
Example
"doctor@example.com"
string
Name of the practitioner
CEL
practitioner_name
Example
"Dr. Jane Smith"
string
Unique identifier for the practitioner
CEL
practitioner_id
Example
"pract456"
[]object
required
Questions included in the note
CEL
questions
Example
[
{
"answer": "Back pain",
"attachments": [
{
"content_type": "application/pdf",
"file_name": "medical_report.pdf",
"id": "12342",
"url": "https://example.com/attachment.pdf"
}
],
"client_profile_field_id": "primary_concern",
"column_names": [
"Symptom",
"Severity"
],
"id": "12342",
"office_note": "Patient reported severe pain",
"office_use": false,
"question_type": "text",
"rows": [
{
"answers": [
"Back pain",
"Severe"
],
"text": "Back pain"
}
],
"text": "What is your primary concern?"
}
]
[]string
required
Mapped array of: Unique identifier for the question
CEL
questions.map(x, x.id)
Example
[
"12342"
]
[]string
required
Mapped array of: Text of the question
CEL
questions.map(x, x.text)
Example
[
"What is your primary concern?"
]
[]string
required
HI Mapped array of: Answer to the questionCEL
questions.map(x, x.answer)
Example
[
"Back pain"
]
[]string
required
Mapped array of: Type of the question
CEL
questions.map(x, x.question_type)
Example
[
"text"
]
[]bool
required
HI Mapped array of: Rows for table/grid questionsCEL
questions.map(x, x.rows)
Example
[
[
{
"answers": [
"Back pain",
"Severe"
],
"text": "Back pain"
}
]
]
[]bool
required
Mapped array of: Column names for table/grid questions
CEL
questions.map(x, x.column_names)
Example
[
[
"Symptom",
"Severity"
]
]
[]bool
required
Mapped array of: Whether the question is for office use only
CEL
questions.map(x, x.office_use)
Example
[
false
]
[]string
required
Mapped array of: Office note for the question
CEL
questions.map(x, x.office_note)
Example
[
"Patient reported severe pain"
]
[]string
required
Mapped array of: ID of the client profile field this question maps to
CEL
questions.map(x, x.client_profile_field_id)
Example
[
"primary_concern"
]
[]bool
required
HI Mapped array of: Attachments associated with the questionCEL
questions.map(x, x.attachments)
Example
[
[
{
"content_type": "application/pdf",
"file_name": "medical_report.pdf",
"id": "12342",
"url": "https://example.com/attachment.pdf"
}
]
]
string
Identifier of the associated appointment
CEL
appointment_id
Example
"54683513554"
timing.v1.Timestamp
required
Timestamp when the note was last modified
CEL
last_modified_at
Example
"2023-01-15T14:30:00Z"