{ "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", "primary_relationship_to_insured": "Primary insured person's relationship to the client", "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"}
IntakeQ
Client
Event payload details and trigger documentation for Client data from Intakeq
{ "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", "primary_relationship_to_insured": "Primary insured person's relationship to the client", "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.
{ "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", "primary_relationship_to_insured": "Primary insured person's relationship to the client", "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
Event Payload
Hide fields
int64
required
IntakeQ’s unique identifier for the client
CEL
client_id
Example
42
string
Full name of the client
CEL
name
Example
"Ettore Bugatti"
string
First name of the client
CEL
first_name
Example
"Ettore"
string
Last name of the client
CEL
last_name
Example
"Bugatti"
string
Middle name of the client
CEL
middle_name
Example
""
string
Email address of the client
CEL
email_address
Example
"ettore@bugatti.com"
string
Primary phone number of the client
CEL
phone_number
Example
"5554016515"
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"
string
Marital status of the client
CEL
marital_status
Example
"Married"
string
Gender of the client
CEL
gender
Example
"Female"
[]string
required
Tags associated with the client
CEL
tags
Example
["website_lead"]
bool
required
Whether the client is archived
CEL
archived
Example
false
string
Home phone number of the client
CEL
home_phone
Example
"(222) 222-2222"
string
Work phone number of the client
CEL
work_phone
Example
"(222) 222-2222"
string
Mobile phone number of the client
CEL
mobile_phone
Example
"(222) 222-2222"
string
Full address of the client
CEL
address
Example
"123 Main St, Anytown, USA 12345"
string
Unit/apartment number of the client’s address
CEL
unit_number
Example
"1A"
string
Street address of the client
CEL
street_address
Example
"123 Main St"
string
City of the client’s address
CEL
city
Example
"Anytown"
string
State/province of the client’s address
CEL
state
Example
"NY"
string
Postal/ZIP code of the client’s address
CEL
postal_code
Example
"12345"
string
Country of the client’s address
CEL
country
Example
"USA"
string
State/province abbreviation of the client’s address