{
  "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
​
client_id
int64
required

IntakeQ’s unique identifier for the client

CEL
client_id
Example
42
​
name
string

Full name of the client

CEL
name
Example
"Ettore Bugatti"
​
first_name
string

First name of the client

CEL
first_name
Example
"Ettore"
​
last_name
string

Last name of the client

CEL
last_name
Example
"Bugatti"
​
middle_name
string

Middle name of the client

CEL
middle_name
Example
""
​
email_address
string

Email address of the client

CEL
email_address
Example
"ettore@bugatti.com"
​
phone_number
string

Primary phone number of the client

CEL
phone_number
Example
"5554016515"
​
date_of_birth
timing.v1.Timestamp

Date of birth of the client (note: This is not rounded to the nearest day by the IntakeQ API)

CEL
date_of_birth
Example
"2016-03-21T04:48:00.368Z"
​
marital_status
string

Marital status of the client

CEL
marital_status
Example
"Married"
​
gender
string

Gender of the client

CEL
gender
Example
"Female"
​
tags
[]string
required

Tags associated with the client

CEL
tags
Example
[
"website_lead"
]
​
archived
bool
required

Whether the client is archived

CEL
archived
Example
false
​
home_phone
string

Home phone number of the client

CEL
home_phone
Example
"(222) 222-2222"
​
work_phone
string

Work phone number of the client

CEL
work_phone
Example
"(222) 222-2222"
​
mobile_phone
string

Mobile phone number of the client

CEL
mobile_phone
Example
"(222) 222-2222"
​
address
string

Full address of the client

CEL
address
Example
"123 Main St, Anytown, USA 12345"
​
unit_number
string

Unit/apartment number of the client’s address

CEL
unit_number
Example
"1A"
​
street_address
string

Street address of the client

CEL
street_address
Example
"123 Main St"
​
city
string

City of the client’s address

CEL
city
Example
"Anytown"
​
state
string

State/province of the client’s address

CEL
state
Example
"NY"
​
postal_code
string

Postal/ZIP code of the client’s address

CEL
postal_code
Example
"12345"
​
country
string

Country of the client’s address

CEL
country
Example
"USA"
​
state_short
string

State/province abbreviation of the client’s address

CEL
state_short
Example
"NY"
​
additional_information
string

Additional information about the client

CEL
additional_information
Example
"test"
​
billing_type
intakeq.v1.BillingType
required

Billing type for the client

CEL
billing_type
Example
SELF_PAY
INSURANCE
​
primary_insurance_company
string

Primary insurance company name

CEL
primary_insurance_company
Example
"MGB"
​
primary_insurance_payer_id
string

Primary insurance payer ID

CEL
primary_insurance_payer_id
Example
"123456"
​
primary_insurance_policy_number
string

Primary insurance policy number

CEL
primary_insurance_policy_number
Example
"654321"
​
primary_insurance_group_number
string

Primary insurance group number

CEL
primary_insurance_group_number
Example
"121212"
​
primary_insurance_holder_name
string

Primary insurance holder name

CEL
primary_insurance_holder_name
Example
"John Smith"
​
primary_insurance_holder_relationship
string

Primary insurance holder relationship to client

CEL
primary_insurance_holder_relationship
Example
"Self"
​
primary_insurance_holder_date_of_birth
timing.v1.Timestamp

Primary insurance holder date of birth

CEL
primary_insurance_holder_date_of_birth
Example
"1988-05-23T00:00:00Z"
​
secondary_insurance_company
string

Secondary insurance company name

CEL
secondary_insurance_company
Example
"MGB"
​
secondary_insurance_payer_id
string

Secondary insurance payer ID

CEL
secondary_insurance_payer_id
Example
"123457"
​
secondary_insurance_policy_number
string

Secondary insurance policy number

CEL
secondary_insurance_policy_number
Example
"654322"
​
secondary_insurance_group_number
string

Secondary insurance group number

CEL
secondary_insurance_group_number
Example
"121213"
​
secondary_insurance_holder_name
string

Secondary insurance holder name

CEL
secondary_insurance_holder_name
Example
"John Smith"
​
secondary_insurance_holder_relationship
string

Secondary insurance holder relationship to client

CEL
secondary_insurance_holder_relationship
Example
"Self"
​
secondary_insurance_holder_date_of_birth
timing.v1.Timestamp

Secondary insurance holder date of birth

CEL
secondary_insurance_holder_date_of_birth
Example
"1988-05-23T00:00:00Z"
​
secondary_relationship_to_insured
string

Secondary insurance relationship to insured

CEL
secondary_relationship_to_insured
Example
"Self"
​
created_at
timing.v1.Timestamp
required

When the client was created

CEL
created_at
Example
"2024-02-25T23:24:31.585Z"
​
last_activity_at
timing.v1.Timestamp

When the client last had activity

CEL
last_activity_at
Example
"2024-02-25T23:24:31.585Z"
​
practitioner_id
string

ID of the assigned practitioner

CEL
practitioner_id
Example
"62e9a2123ccc0219a88d606f"
​
custom_fields
object
required

Custom fields associated with the client

CEL
custom_fields
Example
[
{
"field_id":  "rjrx",
"text":  "Intake Concern",
"value":  "AB1"
}
]
​
custom_fields.map(x, x.field_id)
[]string
required

Mapped array of: ID for the custom field

CEL
custom_fields.map(x, x.field_id)
Example
[
"rjrx"
]
​
custom_fields.map(x, x.text)
[]string
required

Mapped array of: Text for the custom field

CEL
custom_fields.map(x, x.text)
Example
[
"Intake Concern"
]
​
custom_fields.map(x, x.value)
[]string
required

Mapped array of: Value for the custom field

CEL
custom_fields.map(x, x.value)
Example
[
"AB1"
]
​
guid
string

Globally unique identifier for the client

CEL
guid
Example
"dd67fe12-2eea-4776-b5b0-91248102da43"
​
last_updated_at
timing.v1.Timestamp

When the client was last updated

CEL
last_updated_at
Example
"2024-02-25T23:25:01.675Z"
​
stripe_customer_id
string

Stripe customer ID

CEL
stripe_customer_id
Example
"123456"
​
square_customer_id
string

Square customer ID

CEL
square_customer_id
Example
"123456"
​
timezone_id
string

Timezone identifier for the client

CEL
timezone_id
Example
"America/New_York"
​
primary_insurance_plan
string

Primary insurance plan name

CEL
primary_insurance_plan
Example
"MGB"
​
primary_insured_gender
string

Primary insured person’s gender

CEL
primary_insured_gender
Example
"Male"
​
primary_insured_city
string

Primary insured person’s city

CEL
primary_insured_city
Example
"New York"
​
primary_insured_zip_code
string

Primary insured person’s ZIP code

CEL
primary_insured_zip_code
Example
"10001"
​
primary_insured_state
string

Primary insured person’s state

CEL
primary_insured_state
Example
"NY"
​
primary_insured_street_address
string

Primary insured person’s street address

CEL
primary_insured_street_address
Example
"123 Main St"
​
external_client_id
string

External system client ID

CEL
external_client_id
Example
"a7699305-7142-4599-a661-717b6bcd3305"
​
credit_balance
float64 (double)
required

Client’s credit balance

CEL
credit_balance
Example
0
​
last_activity_name
string

Name of the last activity

CEL
last_activity_name
Example
"Created Appt"
​
parent_client_id
string

ID of the parent client if this is a child account

CEL
parent_client_id
Example
"412421"
​
linked_clients
object
required

List of clients linked to this client

CEL
linked_clients
Example
[
{
"client_number":  42,
"relationship_type":  null
}
]
​
linked_clients.map(x, x.client_number)
[]int64
required

Mapped array of: IntakeQ’s unique identifier for the linked client

CEL
linked_clients.map(x, x.client_number)
Example
[
42
]
​
relationship_type
intakeq.v1.RelationshipType
required

Mapped array of: The relationship between the client and the linked client

CEL
relationship_type
Example
PARENT
CHILD
SPOUSE
SIBLING
OTHER
PARTNER