{
  "additional_information": "test",
  "address": "123 Main St, Anytown, USA 12345",
  "archived": false,
  "billing_type": null,
  "city": "Anytown",
  "client_id": 42,
  "country": "USA",
  "created_at": "2024-02-25T23:24:31.585Z",
  "credit_balance": 0,
  "custom_fields": [
    {
      "field_id": "rjrx",
      "text": "Intake Concern",
      "value": "AB1"
    }
  ],
  "date_of_birth": "2016-03-21T04:48:00.368Z",
  "email_address": "ettore@bugatti.com",
  "external_client_id": "a7699305-7142-4599-a661-717b6bcd3305",
  "first_name": "Ettore",
  "gender": "Female",
  "guid": "dd67fe12-2eea-4776-b5b0-91248102da43",
  "home_phone": "(222) 222-2222",
  "last_activity_at": "2024-02-25T23:24:31.585Z",
  "last_activity_name": "Created Appt",
  "last_name": "Bugatti",
  "last_updated_at": "2024-02-25T23:25:01.675Z",
  "linked_clients": [
    {
      "client_number": 42,
      "relationship_type": null
    }
  ],
  "marital_status": "Married",
  "middle_name": "",
  "mobile_phone": "(222) 222-2222",
  "name": "Ettore Bugatti",
  "parent_client_id": "412421",
  "phone_number": "5554016515",
  "postal_code": "12345",
  "practitioner_id": "62e9a2123ccc0219a88d606f",
  "primary_insurance_company": "MGB",
  "primary_insurance_group_number": "121212",
  "primary_insurance_holder_date_of_birth": "1988-05-23T00:00:00Z",
  "primary_insurance_holder_name": "John Smith",
  "primary_insurance_holder_relationship": "Self",
  "primary_insurance_payer_id": "123456",
  "primary_insurance_plan": "MGB",
  "primary_insurance_policy_number": "654321",
  "primary_insured_city": "New York",
  "primary_insured_gender": "Male",
  "primary_insured_state": "NY",
  "primary_insured_street_address": "123 Main St",
  "primary_insured_zip_code": "10001",
  "secondary_insurance_company": "MGB",
  "secondary_insurance_group_number": "121213",
  "secondary_insurance_holder_date_of_birth": "1988-05-23T00:00:00Z",
  "secondary_insurance_holder_name": "John Smith",
  "secondary_insurance_holder_relationship": "Self",
  "secondary_insurance_payer_id": "123457",
  "secondary_insurance_policy_number": "654322",
  "secondary_relationship_to_insured": "Self",
  "square_customer_id": "123456",
  "state": "NY",
  "state_short": "NY",
  "street_address": "123 Main St",
  "stripe_customer_id": "123456",
  "tags": [
    "website_lead"
  ],
  "timezone_id": "America/New_York",
  "unit_number": "1A",
  "work_phone": "(222) 222-2222"
}
{
  "additional_information": "Additional information about the client",
  "address": "Full address of the client",
  "archived": "Whether the client is archived",
  "billing_type": "Billing type for the client",
  "city": "City of the client's address",
  "client_id": "IntakeQ's unique identifier for the client",
  "country": "Country of the client's address",
  "created_at": "When the client was created",
  "credit_balance": "Client's credit balance",
  "custom_fields": {
    "field_id": "ID for the custom field",
    "text": "Text for the custom field",
    "value": "Value for the custom field"
  },
  "date_of_birth": "Date of birth of the client (note: This is not rounded to the nearest day by the IntakeQ API)",
  "email_address": "Email address of the client",
  "external_client_id": "External system client ID",
  "first_name": "First name of the client",
  "gender": "Gender of the client",
  "guid": "Globally unique identifier for the client",
  "home_phone": "Home phone number of the client",
  "last_activity_at": "When the client last had activity",
  "last_activity_name": "Name of the last activity",
  "last_name": "Last name of the client",
  "last_updated_at": "When the client was last updated",
  "linked_clients": {
    "client_number": "IntakeQ's unique identifier for the linked client",
    "relationship_type": "The relationship between the client and the linked client"
  },
  "marital_status": "Marital status of the client",
  "middle_name": "Middle name of the client",
  "mobile_phone": "Mobile phone number of the client",
  "name": "Full name of the client",
  "parent_client_id": "ID of the parent client if this is a child account",
  "phone_number": "Primary phone number of the client",
  "postal_code": "Postal/ZIP code of the client's address",
  "practitioner_id": "ID of the assigned practitioner",
  "primary_insurance_company": "Primary insurance company name",
  "primary_insurance_group_number": "Primary insurance group number",
  "primary_insurance_holder_date_of_birth": "Primary insurance holder date of birth",
  "primary_insurance_holder_name": "Primary insurance holder name",
  "primary_insurance_holder_relationship": "Primary insurance holder relationship to client",
  "primary_insurance_payer_id": "Primary insurance payer ID",
  "primary_insurance_plan": "Primary insurance plan name",
  "primary_insurance_policy_number": "Primary insurance policy number",
  "primary_insured_city": "Primary insured person's city",
  "primary_insured_gender": "Primary insured person's gender",
  "primary_insured_state": "Primary insured person's state",
  "primary_insured_street_address": "Primary insured person's street address",
  "primary_insured_zip_code": "Primary insured person's ZIP code",
  "secondary_insurance_company": "Secondary insurance company name",
  "secondary_insurance_group_number": "Secondary insurance group number",
  "secondary_insurance_holder_date_of_birth": "Secondary insurance holder date of birth",
  "secondary_insurance_holder_name": "Secondary insurance holder name",
  "secondary_insurance_holder_relationship": "Secondary insurance holder relationship to client",
  "secondary_insurance_payer_id": "Secondary insurance payer ID",
  "secondary_insurance_policy_number": "Secondary insurance policy number",
  "secondary_relationship_to_insured": "Secondary insurance relationship to insured",
  "square_customer_id": "Square customer ID",
  "state": "State/province of the client's address",
  "state_short": "State/province abbreviation of the client's address",
  "street_address": "Street address of the client",
  "stripe_customer_id": "Stripe customer ID",
  "tags": "Tags associated with the client",
  "timezone_id": "Timezone identifier for the client",
  "unit_number": "Unit/apartment number of the client's address",
  "work_phone": "Work phone number of the client"
}

Events

Triggering Webhook Types

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

  • Intakeq Client Created
  • Intakeq Client Updated
{
  "additional_information": "test",
  "address": "123 Main St, Anytown, USA 12345",
  "archived": false,
  "billing_type": null,
  "city": "Anytown",
  "client_id": 42,
  "country": "USA",
  "created_at": "2024-02-25T23:24:31.585Z",
  "credit_balance": 0,
  "custom_fields": [
    {
      "field_id": "rjrx",
      "text": "Intake Concern",
      "value": "AB1"
    }
  ],
  "date_of_birth": "2016-03-21T04:48:00.368Z",
  "email_address": "ettore@bugatti.com",
  "external_client_id": "a7699305-7142-4599-a661-717b6bcd3305",
  "first_name": "Ettore",
  "gender": "Female",
  "guid": "dd67fe12-2eea-4776-b5b0-91248102da43",
  "home_phone": "(222) 222-2222",
  "last_activity_at": "2024-02-25T23:24:31.585Z",
  "last_activity_name": "Created Appt",
  "last_name": "Bugatti",
  "last_updated_at": "2024-02-25T23:25:01.675Z",
  "linked_clients": [
    {
      "client_number": 42,
      "relationship_type": null
    }
  ],
  "marital_status": "Married",
  "middle_name": "",
  "mobile_phone": "(222) 222-2222",
  "name": "Ettore Bugatti",
  "parent_client_id": "412421",
  "phone_number": "5554016515",
  "postal_code": "12345",
  "practitioner_id": "62e9a2123ccc0219a88d606f",
  "primary_insurance_company": "MGB",
  "primary_insurance_group_number": "121212",
  "primary_insurance_holder_date_of_birth": "1988-05-23T00:00:00Z",
  "primary_insurance_holder_name": "John Smith",
  "primary_insurance_holder_relationship": "Self",
  "primary_insurance_payer_id": "123456",
  "primary_insurance_plan": "MGB",
  "primary_insurance_policy_number": "654321",
  "primary_insured_city": "New York",
  "primary_insured_gender": "Male",
  "primary_insured_state": "NY",
  "primary_insured_street_address": "123 Main St",
  "primary_insured_zip_code": "10001",
  "secondary_insurance_company": "MGB",
  "secondary_insurance_group_number": "121213",
  "secondary_insurance_holder_date_of_birth": "1988-05-23T00:00:00Z",
  "secondary_insurance_holder_name": "John Smith",
  "secondary_insurance_holder_relationship": "Self",
  "secondary_insurance_payer_id": "123457",
  "secondary_insurance_policy_number": "654322",
  "secondary_relationship_to_insured": "Self",
  "square_customer_id": "123456",
  "state": "NY",
  "state_short": "NY",
  "street_address": "123 Main St",
  "stripe_customer_id": "123456",
  "tags": [
    "website_lead"
  ],
  "timezone_id": "America/New_York",
  "unit_number": "1A",
  "work_phone": "(222) 222-2222"
}
{
  "additional_information": "Additional information about the client",
  "address": "Full address of the client",
  "archived": "Whether the client is archived",
  "billing_type": "Billing type for the client",
  "city": "City of the client's address",
  "client_id": "IntakeQ's unique identifier for the client",
  "country": "Country of the client's address",
  "created_at": "When the client was created",
  "credit_balance": "Client's credit balance",
  "custom_fields": {
    "field_id": "ID for the custom field",
    "text": "Text for the custom field",
    "value": "Value for the custom field"
  },
  "date_of_birth": "Date of birth of the client (note: This is not rounded to the nearest day by the IntakeQ API)",
  "email_address": "Email address of the client",
  "external_client_id": "External system client ID",
  "first_name": "First name of the client",
  "gender": "Gender of the client",
  "guid": "Globally unique identifier for the client",
  "home_phone": "Home phone number of the client",
  "last_activity_at": "When the client last had activity",
  "last_activity_name": "Name of the last activity",
  "last_name": "Last name of the client",
  "last_updated_at": "When the client was last updated",
  "linked_clients": {
    "client_number": "IntakeQ's unique identifier for the linked client",
    "relationship_type": "The relationship between the client and the linked client"
  },
  "marital_status": "Marital status of the client",
  "middle_name": "Middle name of the client",
  "mobile_phone": "Mobile phone number of the client",
  "name": "Full name of the client",
  "parent_client_id": "ID of the parent client if this is a child account",
  "phone_number": "Primary phone number of the client",
  "postal_code": "Postal/ZIP code of the client's address",
  "practitioner_id": "ID of the assigned practitioner",
  "primary_insurance_company": "Primary insurance company name",
  "primary_insurance_group_number": "Primary insurance group number",
  "primary_insurance_holder_date_of_birth": "Primary insurance holder date of birth",
  "primary_insurance_holder_name": "Primary insurance holder name",
  "primary_insurance_holder_relationship": "Primary insurance holder relationship to client",
  "primary_insurance_payer_id": "Primary insurance payer ID",
  "primary_insurance_plan": "Primary insurance plan name",
  "primary_insurance_policy_number": "Primary insurance policy number",
  "primary_insured_city": "Primary insured person's city",
  "primary_insured_gender": "Primary insured person's gender",
  "primary_insured_state": "Primary insured person's state",
  "primary_insured_street_address": "Primary insured person's street address",
  "primary_insured_zip_code": "Primary insured person's ZIP code",
  "secondary_insurance_company": "Secondary insurance company name",
  "secondary_insurance_group_number": "Secondary insurance group number",
  "secondary_insurance_holder_date_of_birth": "Secondary insurance holder date of birth",
  "secondary_insurance_holder_name": "Secondary insurance holder name",
  "secondary_insurance_holder_relationship": "Secondary insurance holder relationship to client",
  "secondary_insurance_payer_id": "Secondary insurance payer ID",
  "secondary_insurance_policy_number": "Secondary insurance policy number",
  "secondary_relationship_to_insured": "Secondary insurance relationship to insured",
  "square_customer_id": "Square customer ID",
  "state": "State/province of the client's address",
  "state_short": "State/province abbreviation of the client's address",
  "street_address": "Street address of the client",
  "stripe_customer_id": "Stripe customer ID",
  "tags": "Tags associated with the client",
  "timezone_id": "Timezone identifier for the client",
  "unit_number": "Unit/apartment number of the client's address",
  "work_phone": "Work phone number of the client"
}

Payload Field Details

Client
Event Payload