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