{
  "appointment_id":  "54683513554",
  "client_email":  "john.doe@example.com",
  "client_id":  12345,
  "client_name":  "John Doe",
  "id":  "note123",
  "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",
  "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/updated"
}

Events

Triggering Webhook Types

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

Intakeq Note Locked

{
  "appointment_id":  "54683513554",
  "client_email":  "john.doe@example.com",
  "client_id":  12345,
  "client_name":  "John Doe",
  "id":  "note123",
  "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",
  "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/updated"
}

Payload Field Details

Note

Event Payload

string

required

Unique identifier for the note

CEL
id

Example
"note123"

client_name

string

Name of the client

CEL
client_name

Example
"John Doe"

client_email

string

Email address of the client

CEL
client_email

Example
"john.doe@example.com"

client_id

int64

required

Unique identifier for the client

CEL
client_id

Example
12345

status

string

required

Status of the note

CEL
status

Example
"locked or unlocked"

timestamp

timing.v1.Timestamp

required

Timestamp when the note was created/updated

CEL
timestamp

Example
"2023-01-15T14:30:00Z"

note_name

string

Name of the note

CEL
note_name

Example
"Initial Assessment"

practitioner_email

string

Email of the practitioner

CEL
practitioner_email

Example
"doctor@example.com"

practitioner_name

string

Name of the practitioner

CEL
practitioner_name

Example
"Dr. Jane Smith"

practitioner_id

string

Unique identifier for the practitioner

CEL
practitioner_id

Example
"pract456"

questions

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?"
}
]

questions.map(x, x.id)

[]string

required

Mapped array of: Unique identifier for the question

CEL
questions.map(x, x.id)

Example
[
"12342"
]

questions.map(x, x.text)

[]string

required

Mapped array of: Text of the question

CEL
questions.map(x, x.text)

Example
[
"What is your primary concern?"
]

questions.map(x, x.answer)

[]string

required

HI Mapped array of: Answer to the question

CEL
questions.map(x, x.answer)

Example
[
"Back pain"
]

questions.map(x, x.question_type)

[]string

required

Mapped array of: Type of the question

CEL
questions.map(x, x.question_type)

Example
[
"text"
]

questions.map(x, x.rows)

[]bool

required

HI Mapped array of: Rows for table/grid questions

CEL
questions.map(x, x.rows)

Example
[
[
{
"answers":  [
  "Back pain",
  "Severe"
],
"text":  "Back pain"
}
]
]

questions.map(x, x.rows)

[]bool

required

HI Mapped array of: Rows for table/grid questions

CEL
questions.map(x, x.rows)

Example
[
[
{
"answers":  [
  "Back pain",
  "Severe"
],
"text":  "Back pain"
}
]
]

questions.map(x, x.rows)

[]bool

required

HI Mapped array of: Rows for table/grid questions

CEL
questions.map(x, x.rows)

Example
[
[
{
"answers":  [
  "Back pain",
  "Severe"
],
"text":  "Back pain"
}
]
]

questions.map(x, x.column_names)

[]bool

required

Mapped array of: Column names for table/grid questions

CEL
questions.map(x, x.column_names)

Example
[
[
"Symptom",
"Severity"
]
]

questions.map(x, x.office_use)

[]bool

required

Mapped array of: Whether the question is for office use only

CEL
questions.map(x, x.office_use)

Example
[
false
]

questions.map(x, x.office_note)

[]string

required

Mapped array of: Office note for the question

CEL
questions.map(x, x.office_note)

Example
[
"Patient reported severe pain"
]

questions.map(x, x.client_profile_field_id)

[]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"
]