{ "active": "Whether the User is active", "active_tags": "List of active tags for the User", "additional_phone_number": "Additional phone number of the user", "additional_record_identifier": "Additional record identifier for the User (an extra external unique patient ID reference)", "brand": { "about_description": "Brand owner's about description", "brand_email": "Brand owner's brand email", "brand_name": "Name of provider's brand", "brand_phone": "Brand owner's brand phone" }, "changed_fields": "Healthie User object fields changed in triggering the event for this User (Patient)", "client_readable_source": "Client readable source for the user", "client_source": { "id": "ID of the client source", "readable_source": "Get readable source based on ref_type", "ref_source": "The source of how a client was acquired: contain ID or a Other string", "ref_source_other": "If ref_source eq 'Other', than it may contain custom string or NULL", "ref_type": "The type of the source of how a client was acquired", "related_insurance_id": "ID of the related insurance", "related_object_id": "ID of the related object, or 'Other'", "related_object_name": "Name of the related object" }, "course_memberships": { "course_id": "ID of the course", "course_name": "Name of the course", "course_status": "Status of the course membership", "started_at": "Time the course membership started", "updated_at": "Time the course membership was last updated" }, "date_of_birth": "Date of birth of the User", "default_stripe_customer_detail_id": "Default Stripe customer detail ID", "diagnoses": { "active": "Whether the diagnosis is currently active", "end_date": "Date the diagnosis ended", "first_symptom_date": "Date of first symptoms", "icd_code": { "code": "ICD code", "display_name": "Display name for the ICD code" } }, "dietician_organization_id": "Organization ID for the user's registered dietitian", "dietitian_email_address": "Email address of the User's registered dietitian", "dietitian_first_name": "First name of the User's registered dietitian", "dietitian_id": "ID of the User's registered dietitian", "dietitian_last_name": "Last name of the User's registered dietitian", "dietitian_organization_id": "Organization ID for the User's registered dietitian", "dietitian_organization_location_id": "Organization's location ID for the User's registered dietitian", "dietitian_organization_name": "Organization name for the user's registered dietitian", "email_address": "Email address of the User", "first_name": "First name of the User", "gender": "Gender", "gender_identity": "Gender identity", "has_created_password": "Whether the User has created a password", "height_meters": "Height in meters", "id": "ID for the User", "insurance_authorization": { "end_on": "The day that visits authorized by the insurance company have no effect", "start_on": "The day that visits authorized by the insurance company take effect", "units_authorized": "Number of units authorized", "units_left": "Number of units left", "units_used": "Number of units used", "visits_left": "Number of visits left" }, "is_patient": "Whether the user is a patient", "last_active": "Time the User was last active", "last_appt_date": "The datetime of the last appointment the Patient had", "last_appt_id": "The last scheduled appointment ID for this Patient (if specified)", "last_name": "Last name of the User", "legal_name": "Legal name of the Patient", "location": { "city": "City", "country": "Country", "line1": "First line of the address", "line2": "Second line of the address", "state": "State", "zip": "Zip code" }, "metadata": "Metadata for the user", "money_owed": "Amount of money owed by the User", "next_appt_date": "The timestamp of the next scheduled appointment for this Patient (if scheduled)", "next_appt_id": "The next scheduled appointment ID for this Patient (if specified)", "next_required_step": "Next required step for the User", "notification_contacts": { "email_address": "Email address of the notification contact", "first_name": "First name of the notification contact", "id": "ID for the notification contact", "is_emergency_contact": "Whether the notification contact is an emergency contact", "last_name": "Last name of the notification contact", "phone_number": "Phone number of the notification contact", "relationship": "Relationship between the notification contact and the user" }, "npi": "National Provider Identifier, this field only applies if the user is a provider", "other_provider_ids": "List of other provider IDs associated with the User", "phone_number": "Phone number of the User", "policies": { "benefits": { "coinsurance": "Coinsurance percentage due", "copay": "Copay amount due", "deductible_calendar_year": "Deductible amount for the calendar year", "deductible_year_to_date": "Deductible amount for the year to-date" }, "effective_end": "Date the policy coverage expires", "group_num": "Group number", "id": "ID for the policy", "insurance_card_back_id": "ID of the insurance card back image object", "insurance_card_front_id": "ID of the insurance card front image object", "insurance_plan": { "id": "ID of the insurance plan", "name_and_id": "Name of the payer and id of payer", "payer_id": "ID of the insurance payer", "payer_name": "Name of the insurance payer" }, "insurance_type": "The type of insurance: `type_string`", "notes": "Notes about the policy", "num": "Policy number", "patient_id": "ID of the patient associated with the policy", "priority_type": "The priority type of insurance: `priority_type`", "updated_at": "Last time the Policy was updated" }, "primary_ethnicity_code": "The primary ethnicity code for the Patient", "primary_race": "Primary race", "primary_race_code": "The primary race code for the Patient", "pronouns": "Pronouns", "providers": { "first_name": "First name of the provider", "id": "ID for the provider", "last_name": "Last name of the provider", "name": "Name of the provider", "qualifications": "Qualifications of the provider" }, "quick_notes": "Quick notes about the user", "record_identifier": "Record identifier for the User (external unique patient ID reference)", "referring_physician_emails": "List of referring physician emails", "referring_physicians": { "business_name": "Provider's business name", "created_at": "Provider's creation date", "email": "Provider's email", "first_name": "Provider's first name", "full_name": "Provider's full name", "id": "Provider ID", "last_name": "Provider's last name", "location": { "city": "City", "country": "Country", "line1": "First line of the address", "line2": "Second line of the address", "state": "State", "zip": "Zip code" }, "npi": "Provider's NPI", "phone_number": "Provider's phone number" }, "referring_provider_name": "Name of the referring provider", "set_password_link": "Password setup hyperlink", "sex": "Sex", "sex_assigned_at_birth": "Sex assigned at birth", "sexual_orientation": "Sexual orientation", "state_licenses": { "full_state_name": "The full name of the State", "id": "The unique identifier of the State license", "state": "The abbreviation of the State" }, "timezone": "Timezone registered for the User", "timing": { "created_at": "Time the object was created", "updated_at": "Time the object was updated" }, "unconfirmed_appointment_count": "Number of unconfirmed appointments", "user_group": { "created_at": "When the User Group was created", "id": "ID of the User Group", "name": "Name of the User Group" }, "weight_kilograms": "Weight in kilograms"}
Healthie
User
Event payload details and trigger documentation for User data from Healthie
{ "active": "Whether the User is active", "active_tags": "List of active tags for the User", "additional_phone_number": "Additional phone number of the user", "additional_record_identifier": "Additional record identifier for the User (an extra external unique patient ID reference)", "brand": { "about_description": "Brand owner's about description", "brand_email": "Brand owner's brand email", "brand_name": "Name of provider's brand", "brand_phone": "Brand owner's brand phone" }, "changed_fields": "Healthie User object fields changed in triggering the event for this User (Patient)", "client_readable_source": "Client readable source for the user", "client_source": { "id": "ID of the client source", "readable_source": "Get readable source based on ref_type", "ref_source": "The source of how a client was acquired: contain ID or a Other string", "ref_source_other": "If ref_source eq 'Other', than it may contain custom string or NULL", "ref_type": "The type of the source of how a client was acquired", "related_insurance_id": "ID of the related insurance", "related_object_id": "ID of the related object, or 'Other'", "related_object_name": "Name of the related object" }, "course_memberships": { "course_id": "ID of the course", "course_name": "Name of the course", "course_status": "Status of the course membership", "started_at": "Time the course membership started", "updated_at": "Time the course membership was last updated" }, "date_of_birth": "Date of birth of the User", "default_stripe_customer_detail_id": "Default Stripe customer detail ID", "diagnoses": { "active": "Whether the diagnosis is currently active", "end_date": "Date the diagnosis ended", "first_symptom_date": "Date of first symptoms", "icd_code": { "code": "ICD code", "display_name": "Display name for the ICD code" } }, "dietician_organization_id": "Organization ID for the user's registered dietitian", "dietitian_email_address": "Email address of the User's registered dietitian", "dietitian_first_name": "First name of the User's registered dietitian", "dietitian_id": "ID of the User's registered dietitian", "dietitian_last_name": "Last name of the User's registered dietitian", "dietitian_organization_id": "Organization ID for the User's registered dietitian", "dietitian_organization_location_id": "Organization's location ID for the User's registered dietitian", "dietitian_organization_name": "Organization name for the user's registered dietitian", "email_address": "Email address of the User", "first_name": "First name of the User", "gender": "Gender", "gender_identity": "Gender identity", "has_created_password": "Whether the User has created a password", "height_meters": "Height in meters", "id": "ID for the User", "insurance_authorization": { "end_on": "The day that visits authorized by the insurance company have no effect", "start_on": "The day that visits authorized by the insurance company take effect", "units_authorized": "Number of units authorized", "units_left": "Number of units left", "units_used": "Number of units used", "visits_left": "Number of visits left" }, "is_patient": "Whether the user is a patient", "last_active": "Time the User was last active", "last_appt_date": "The datetime of the last appointment the Patient had", "last_appt_id": "The last scheduled appointment ID for this Patient (if specified)", "last_name": "Last name of the User", "legal_name": "Legal name of the Patient", "location": { "city": "City", "country": "Country", "line1": "First line of the address", "line2": "Second line of the address", "state": "State", "zip": "Zip code" }, "metadata": "Metadata for the user", "money_owed": "Amount of money owed by the User", "next_appt_date": "The timestamp of the next scheduled appointment for this Patient (if scheduled)", "next_appt_id": "The next scheduled appointment ID for this Patient (if specified)", "next_required_step": "Next required step for the User", "notification_contacts": { "email_address": "Email address of the notification contact", "first_name": "First name of the notification contact", "id": "ID for the notification contact", "is_emergency_contact": "Whether the notification contact is an emergency contact", "last_name": "Last name of the notification contact", "phone_number": "Phone number of the notification contact", "relationship": "Relationship between the notification contact and the user" }, "npi": "National Provider Identifier, this field only applies if the user is a provider", "other_provider_ids": "List of other provider IDs associated with the User", "phone_number": "Phone number of the User", "policies": { "benefits": { "coinsurance": "Coinsurance percentage due", "copay": "Copay amount due", "deductible_calendar_year": "Deductible amount for the calendar year", "deductible_year_to_date": "Deductible amount for the year to-date" }, "effective_end": "Date the policy coverage expires", "group_num": "Group number", "id": "ID for the policy", "insurance_card_back_id": "ID of the insurance card back image object", "insurance_card_front_id": "ID of the insurance card front image object", "insurance_plan": { "id": "ID of the insurance plan", "name_and_id": "Name of the payer and id of payer", "payer_id": "ID of the insurance payer", "payer_name": "Name of the insurance payer" }, "insurance_type": "The type of insurance: `type_string`", "notes": "Notes about the policy", "num": "Policy number", "patient_id": "ID of the patient associated with the policy", "priority_type": "The priority type of insurance: `priority_type`", "updated_at": "Last time the Policy was updated" }, "primary_ethnicity_code": "The primary ethnicity code for the Patient", "primary_race": "Primary race", "primary_race_code": "The primary race code for the Patient", "pronouns": "Pronouns", "providers": { "first_name": "First name of the provider", "id": "ID for the provider", "last_name": "Last name of the provider", "name": "Name of the provider", "qualifications": "Qualifications of the provider" }, "quick_notes": "Quick notes about the user", "record_identifier": "Record identifier for the User (external unique patient ID reference)", "referring_physician_emails": "List of referring physician emails", "referring_physicians": { "business_name": "Provider's business name", "created_at": "Provider's creation date", "email": "Provider's email", "first_name": "Provider's first name", "full_name": "Provider's full name", "id": "Provider ID", "last_name": "Provider's last name", "location": { "city": "City", "country": "Country", "line1": "First line of the address", "line2": "Second line of the address", "state": "State", "zip": "Zip code" }, "npi": "Provider's NPI", "phone_number": "Provider's phone number" }, "referring_provider_name": "Name of the referring provider", "set_password_link": "Password setup hyperlink", "sex": "Sex", "sex_assigned_at_birth": "Sex assigned at birth", "sexual_orientation": "Sexual orientation", "state_licenses": { "full_state_name": "The full name of the State", "id": "The unique identifier of the State license", "state": "The abbreviation of the State" }, "timezone": "Timezone registered for the User", "timing": { "created_at": "Time the object was created", "updated_at": "Time the object was updated" }, "unconfirmed_appointment_count": "Number of unconfirmed appointments", "user_group": { "created_at": "When the User Group was created", "id": "ID of the User Group", "name": "Name of the User Group" }, "weight_kilograms": "Weight in kilograms"}
Events
Triggering Webhook Types
The following event types are associated with the User event payload from Healthie.
{ "active": "Whether the User is active", "active_tags": "List of active tags for the User", "additional_phone_number": "Additional phone number of the user", "additional_record_identifier": "Additional record identifier for the User (an extra external unique patient ID reference)", "brand": { "about_description": "Brand owner's about description", "brand_email": "Brand owner's brand email", "brand_name": "Name of provider's brand", "brand_phone": "Brand owner's brand phone" }, "changed_fields": "Healthie User object fields changed in triggering the event for this User (Patient)", "client_readable_source": "Client readable source for the user", "client_source": { "id": "ID of the client source", "readable_source": "Get readable source based on ref_type", "ref_source": "The source of how a client was acquired: contain ID or a Other string", "ref_source_other": "If ref_source eq 'Other', than it may contain custom string or NULL", "ref_type": "The type of the source of how a client was acquired", "related_insurance_id": "ID of the related insurance", "related_object_id": "ID of the related object, or 'Other'", "related_object_name": "Name of the related object" }, "course_memberships": { "course_id": "ID of the course", "course_name": "Name of the course", "course_status": "Status of the course membership", "started_at": "Time the course membership started", "updated_at": "Time the course membership was last updated" }, "date_of_birth": "Date of birth of the User", "default_stripe_customer_detail_id": "Default Stripe customer detail ID", "diagnoses": { "active": "Whether the diagnosis is currently active", "end_date": "Date the diagnosis ended", "first_symptom_date": "Date of first symptoms", "icd_code": { "code": "ICD code", "display_name": "Display name for the ICD code" } }, "dietician_organization_id": "Organization ID for the user's registered dietitian", "dietitian_email_address": "Email address of the User's registered dietitian", "dietitian_first_name": "First name of the User's registered dietitian", "dietitian_id": "ID of the User's registered dietitian", "dietitian_last_name": "Last name of the User's registered dietitian", "dietitian_organization_id": "Organization ID for the User's registered dietitian", "dietitian_organization_location_id": "Organization's location ID for the User's registered dietitian", "dietitian_organization_name": "Organization name for the user's registered dietitian", "email_address": "Email address of the User", "first_name": "First name of the User", "gender": "Gender", "gender_identity": "Gender identity", "has_created_password": "Whether the User has created a password", "height_meters": "Height in meters", "id": "ID for the User", "insurance_authorization": { "end_on": "The day that visits authorized by the insurance company have no effect", "start_on": "The day that visits authorized by the insurance company take effect", "units_authorized": "Number of units authorized", "units_left": "Number of units left", "units_used": "Number of units used", "visits_left": "Number of visits left" }, "is_patient": "Whether the user is a patient", "last_active": "Time the User was last active", "last_appt_date": "The datetime of the last appointment the Patient had", "last_appt_id": "The last scheduled appointment ID for this Patient (if specified)", "last_name": "Last name of the User", "legal_name": "Legal name of the Patient", "location": { "city": "City", "country": "Country", "line1": "First line of the address", "line2": "Second line of the address", "state": "State", "zip": "Zip code" }, "metadata": "Metadata for the user", "money_owed": "Amount of money owed by the User", "next_appt_date": "The timestamp of the next scheduled appointment for this Patient (if scheduled)", "next_appt_id": "The next scheduled appointment ID for this Patient (if specified)", "next_required_step": "Next required step for the User", "notification_contacts": { "email_address": "Email address of the notification contact", "first_name": "First name of the notification contact", "id": "ID for the notification contact", "is_emergency_contact": "Whether the notification contact is an emergency contact", "last_name": "Last name of the notification contact", "phone_number": "Phone number of the notification contact", "relationship": "Relationship between the notification contact and the user" }, "npi": "National Provider Identifier, this field only applies if the user is a provider", "other_provider_ids": "List of other provider IDs associated with the User", "phone_number": "Phone number of the User", "policies": { "benefits": { "coinsurance": "Coinsurance percentage due", "copay": "Copay amount due", "deductible_calendar_year": "Deductible amount for the calendar year", "deductible_year_to_date": "Deductible amount for the year to-date" }, "effective_end": "Date the policy coverage expires", "group_num": "Group number", "id": "ID for the policy", "insurance_card_back_id": "ID of the insurance card back image object", "insurance_card_front_id": "ID of the insurance card front image object", "insurance_plan": { "id": "ID of the insurance plan", "name_and_id": "Name of the payer and id of payer", "payer_id": "ID of the insurance payer", "payer_name": "Name of the insurance payer" }, "insurance_type": "The type of insurance: `type_string`", "notes": "Notes about the policy", "num": "Policy number", "patient_id": "ID of the patient associated with the policy", "priority_type": "The priority type of insurance: `priority_type`", "updated_at": "Last time the Policy was updated" }, "primary_ethnicity_code": "The primary ethnicity code for the Patient", "primary_race": "Primary race", "primary_race_code": "The primary race code for the Patient", "pronouns": "Pronouns", "providers": { "first_name": "First name of the provider", "id": "ID for the provider", "last_name": "Last name of the provider", "name": "Name of the provider", "qualifications": "Qualifications of the provider" }, "quick_notes": "Quick notes about the user", "record_identifier": "Record identifier for the User (external unique patient ID reference)", "referring_physician_emails": "List of referring physician emails", "referring_physicians": { "business_name": "Provider's business name", "created_at": "Provider's creation date", "email": "Provider's email", "first_name": "Provider's first name", "full_name": "Provider's full name", "id": "Provider ID", "last_name": "Provider's last name", "location": { "city": "City", "country": "Country", "line1": "First line of the address", "line2": "Second line of the address", "state": "State", "zip": "Zip code" }, "npi": "Provider's NPI", "phone_number": "Provider's phone number" }, "referring_provider_name": "Name of the referring provider", "set_password_link": "Password setup hyperlink", "sex": "Sex", "sex_assigned_at_birth": "Sex assigned at birth", "sexual_orientation": "Sexual orientation", "state_licenses": { "full_state_name": "The full name of the State", "id": "The unique identifier of the State license", "state": "The abbreviation of the State" }, "timezone": "Timezone registered for the User", "timing": { "created_at": "Time the object was created", "updated_at": "Time the object was updated" }, "unconfirmed_appointment_count": "Number of unconfirmed appointments", "user_group": { "created_at": "When the User Group was created", "id": "ID of the User Group", "name": "Name of the User Group" }, "weight_kilograms": "Weight in kilograms"}
Payload Field Details
Event Payload
Hide fields
string
required
ID ID for the User
CEL
id
Example
"131391"
string
ID Record identifier for the User (external unique patient ID reference)
The next scheduled appointment ID for this Patient (if specified)
CEL
next_appt_id
Example
"604821"
string
The last scheduled appointment ID for this Patient (if specified)
CEL
last_appt_id
Example
"604820"
string
PII Legal name of the Patient
CEL
legal_name
Example
"Test Patient"
[]string
required
Healthie User object fields changed in triggering the event for this User (Patient)
CEL
changed_fields
Example
["email_address","first_name","last_name"]
string
ID National Provider Identifier, this field only applies if the user is a provider
CEL
npi
Example
"1234567890"
bool
Whether the user is a patient
CEL
is_patient
Example
true
[]object
required
The licenses for the Provider if this User is a Provider
CEL
state_licenses
Example
[{"full_state_name": "New York","id": "500073","state": "NY"}]
[]string
required
Mapped array of: The unique identifier of the State license
CEL
state_licenses.map(x, x.id)
Example
["500073"]
[]string
required
Mapped array of: The abbreviation of the State
CEL
state_licenses.map(x, x.state)
Example
["NY"]
[]string
required
Mapped array of: The full name of the State
CEL
state_licenses.map(x, x.full_state_name)
Example
["New York"]
string
Organization’s location ID for the User’s registered dietitian
CEL
dietitian_organization_location_id
Example
"12345"
string
PII Additional phone number of the user
CEL
additional_phone_number
Example
"+15559876543"
string
ID Additional record identifier for the User (an extra external unique patient ID reference)
CEL
additional_record_identifier
Example
"2847455b-caed-4d97-a79c-1f07316e7fbf"
string
Organization name for the user’s registered dietitian
CEL
dietitian_organization_name
Example
"Morf"
object
Brand details for the User
CEL
brand
Example
{"about_description": "We provide comprehensive health services","brand_email": "brand@example.com","brand_name": "My Health Brand","brand_phone": "+15551234567"}