Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt

Use this file to discover all available pages before exploring further.

images/intakeq.svg

​
Events

​
Triggering Webhook Types

The following event types are associated with the Intake Form event payload from Intakeq.
  • Intakeq Intake Form Submitted
{
  "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"
}

{
  "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

​
Intake Form
Event Payload