Events
Triggering Webhook Types
The following event types are associated with the Intake Form event payload from Intakeq.Intakeq Intake Form Submitted
Copy
Ask AI
{
  "appointment_id": "12342",
  "client_email": "john.smith@example.com",
  "client_id": 42,
  "client_name": "John Smith",
  "consent_forms": [
    {
      "document_type": "HIPAA",
      "id": "12342",
      "name": "HIPAA Consent",
      "signed": true,
      "submitted_at": "2024-01-23T10:30:00Z"
    }
  ],
  "created_at": "2024-01-23T10:00:00Z",
  "external_client_id": "a7699305-7142-4599-a661-717b6bcd3305",
  "id": "12342",
  "practitioner": "acbdefg",
  "practitioner_name": "Dr. Marie Curie",
  "questionnaire_name": "Initial Intake Form",
  "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": "Submitted",
  "submitted_at": "2024-01-23T10:30:00Z"
}
Copy
Ask AI
{
  "appointment_id": "ID of the associated appointment",
  "client_email": "Email address of the client",
  "client_id": "IntakeQ's unique identifier for the client",
  "client_name": "Full name of the client",
  "consent_forms": {
    "document_type": "Type of the consent document",
    "id": "Unique identifier for the consent form",
    "name": "Name of the consent form",
    "signed": "Whether the consent form has been signed",
    "submitted_at": "Time the consent form was submitted"
  },
  "created_at": "Time the intake form was created",
  "external_client_id": "External system client ID",
  "id": "Unique identifier for the intake form",
  "practitioner": "ID of the practitioner",
  "practitioner_name": "Name of the practitioner",
  "questionnaire_name": "Name of the questionnaire",
  "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 intake form",
  "submitted_at": "Time the intake form was submitted"
}
Payload Field Details
Hide fields
Hide fields
Unique identifier for the intake form
CEL
Copy
Ask AI
id
Example
Copy
Ask AI
"12342"
PII Full name of the clientCEL
Copy
Ask AI
client_name
Example
Copy
Ask AI
"John Smith"
PII Email address of the clientCEL
Copy
Ask AI
client_email
Example
Copy
Ask AI
"john.smith@example.com"
ID IntakeQ’s unique identifier for the clientCEL
Copy
Ask AI
client_id
Example
Copy
Ask AI
42
Status of the intake form
CEL
Copy
Ask AI
status
Example
Copy
Ask AI
"Submitted"
Time the intake form was created
CEL
Copy
Ask AI
created_at
Example
Copy
Ask AI
"2024-01-23T10:00:00Z"
Time the intake form was submitted
CEL
Copy
Ask AI
submitted_at
Example
Copy
Ask AI
"2024-01-23T10:30:00Z"
Name of the questionnaire
CEL
Copy
Ask AI
questionnaire_name
Example
Copy
Ask AI
"Initial Intake Form"
ID of the practitioner
CEL
Copy
Ask AI
practitioner
Example
Copy
Ask AI
"acbdefg"
Name of the practitioner
CEL
Copy
Ask AI
practitioner_name
Example
Copy
Ask AI
"Dr. Marie Curie"
HI Questions and answers in the intake formCEL
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"
}
]
]
ID of the associated appointment
CEL
Copy
Ask AI
appointment_id
Example
Copy
Ask AI
"12342"
ID External system client IDCEL
Copy
Ask AI
external_client_id
Example
Copy
Ask AI
"a7699305-7142-4599-a661-717b6bcd3305"
HI Consent forms associated with the intake formCEL
Copy
Ask AI
consent_forms
Example
Copy
Ask AI
[
{
"document_type": "HIPAA",
"id": "12342",
"name": "HIPAA Consent",
"signed": true,
"submitted_at": "2024-01-23T10:30:00Z"
}
]
Mapped array of: Unique identifier for the consent form
CEL
Copy
Ask AI
consent_forms.map(x, x.id)
Example
Copy
Ask AI
[
"12342"
]
Mapped array of: Name of the consent form
CEL
Copy
Ask AI
consent_forms.map(x, x.name)
Example
Copy
Ask AI
[
"HIPAA Consent"
]
Mapped array of: Type of the consent document
CEL
Copy
Ask AI
consent_forms.map(x, x.document_type)
Example
Copy
Ask AI
[
"HIPAA"
]
Mapped array of: Whether the consent form has been signed
CEL
Copy
Ask AI
consent_forms.map(x, x.signed)
Example
Copy
Ask AI
[
true
]
Mapped array of: Time the consent form was submitted
CEL
Copy
Ask AI
consent_forms.map(x, x.submitted_at)
Example
Copy
Ask AI
[
"2024-01-23T10:30:00Z"
]
