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