Skip to main content
images/hint_health.svg

Events

Triggering Webhook Types

The following event types are associated with the Patient event payload from Hint Health.
  • Hint Health Patient Created
  • Hint Health Patient Updated
  • Hint Health Patient Destroyed
  • Hint Health Patient Inactive
{
  "account": {
    "name": "Gordon Thomas Sumner",
    "past_due_in_cents": 0
  },
  "address_city": "New York",
  "address_country": "United States",
  "address_line1": "157 E Houston St",
  "address_line2": "Suite 2402",
  "address_state": "NY",
  "address_zip": "10002",
  "age": 60,
  "chosen_first_name": "Alex",
  "chosen_last_name": "Smith",
  "chosen_middle_name": "Jordan",
  "chosen_suffix": "Jr.",
  "chosen_title": "Dr.",
  "company": {
    "id": "com-ab12C345DeF6",
    "name": "Schmoogle Inc."
  },
  "created_at": null,
  "dob": null,
  "electronic_communication_consent_accepted": true,
  "electronic_communication_consent_accepted_at": null,
  "email": "bass_man@bumblebeeinc.com",
  "external_link_id": "ext-12345",
  "external_records": [
    {
      "external_id": "ext-98765",
      "source": "ehr_system"
    }
  ],
  "first_name": "Gordon",
  "gender": "male",
  "gender_identity": "man",
  "gender_other": "non-binary",
  "health_insurance_group_id": "12345",
  "health_insurance_member_id": "A22222222",
  "health_insurance_payer_id": "00039",
  "health_insurance_payer_name": "Anthem Blue Cross California",
  "hipaa_authorization_accepted": true,
  "hipaa_authorization_accepted_at": null,
  "id": "pat-ab12C345DeF6",
  "import_id": "imp-ab12C345DeF6",
  "import_source": "csv_upload",
  "joined_practice_date": null,
  "known_practice": {
    "id": "prc-ab12C345DeF6",
    "name": "Downtown Medical"
  },
  "last_name": "Sumner",
  "lead_source": {
    "created_at": null,
    "id": "lds-ab12C345DeF6",
    "name": "Other",
    "updated_at": null
  },
  "lead_source_other": "Downtown marketing event",
  "location": {
    "address_city": "New York",
    "address_country": "United States",
    "address_latitude": "40.7227998",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_longitude": "-73.9892241",
    "address_state": "NY",
    "address_zip": "10002",
    "distance": "5.2 miles",
    "id": "loc-ab12C345DeF6",
    "location_group": {
      "created_at": null,
      "id": "prg-ab12C345DeF6",
      "integration_record_id": "int-ab12C345DeF6",
      "name": "Downtown Location Group",
      "updated_at": null
    },
    "name": "San Francisco HQ",
    "phone_number": "+15551234567",
    "virtual": false
  },
  "location_group": {
    "created_at": null,
    "id": "prg-ab12C345DeF6",
    "integration_record_id": "int-ab12C345DeF6",
    "name": "Downtown Location Group",
    "updated_at": null
  },
  "master_record_sponsor": "creg-ab12C345DeF6",
  "membership_status": "active",
  "memberships": [
    {
      "company": {
        "id": "com-ab12C345DeF6",
        "name": "Schmoogle Inc."
      },
      "division": {
        "id": "div-ab12C345DeF6",
        "name": "division 20"
      },
      "end_date": null,
      "enrollment_requested_on": null,
      "enrollment_status": "active",
      "member_type": "spouse",
      "payer": {
        "id": "pat-ab12C345DeF6",
        "name": "Gordon Thomas Sumner"
      },
      "plan": {
        "id": "pln-ab12C345DeF6",
        "name": "Membership"
      },
      "start_date": null,
      "status": "active",
      "uses_tobacco": false
    }
  ],
  "merged_into": {
    "id": "pat-zz99Y888XwV7",
    "name": "Gordon Thomas Sumner"
  },
  "middle_name": "Thomas",
  "name": "Gordon Thomas Sumner",
  "patient_agreement_accepted": false,
  "patient_agreement_accepted_at": null,
  "phones": [
    {
      "number": "+15553050051",
      "type": "mobile"
    }
  ],
  "practitioner": {
    "accepts_enrollments_from_employer": "yes",
    "accepts_enrollments_from_retail": "yes",
    "bio": "Board-certified family medicine physician with 15 years of experience.",
    "created_at": null,
    "education": "MD, Johns Hopkins University",
    "email": "dr.smith@practice.com",
    "gender": "female",
    "gender_other": "non-binary",
    "id": "doc-ab12C345DeF6",
    "integration_record_id": "int-ab12C345DeF6",
    "locations": [
      {
        "address_city": "New York",
        "address_country": "United States",
        "address_latitude": "40.7227998",
        "address_line1": "157 E Houston St",
        "address_line2": "Suite 2402",
        "address_longitude": "-73.9892241",
        "address_state": "NY",
        "address_zip": "10002",
        "distance": "5.2 miles",
        "id": "loc-ab12C345DeF6",
        "location_group": {
          "created_at": null,
          "id": "prg-ab12C345DeF6",
          "integration_record_id": "int-ab12C345DeF6",
          "name": "Downtown Location Group",
          "updated_at": null
        },
        "name": "San Francisco HQ",
        "phone_number": "+15551234567",
        "virtual": false
      }
    ],
    "max_patient_age": "65",
    "min_patient_age": "18",
    "name": "Dr. Jane Smith",
    "npi": {
      "id": "1234567890",
      "name": "Dr. Jane Smith"
    },
    "online_signup_visibility": "visible",
    "panel_size": 250,
    "panel_size_limit": 500,
    "photo_url": "https://app.hint.com/photos/doc-ab12C345DeF6.jpg",
    "specialties": [
      {
        "id": "spc-ab12C345DeF6",
        "name": "Family Medicine"
      }
    ],
    "updated_at": null
  },
  "practitioner_group": {
    "created_at": null,
    "id": "prg-ab12C345DeF6",
    "integration_record_id": "int-ab12C345DeF6",
    "name": "Downtown Location Group",
    "updated_at": null
  },
  "preferred_language": "en",
  "pronouns": "he/him",
  "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
  "sex": "male",
  "sponsorships": [
    {
      "company": {
        "id": "com-ab12C345DeF6",
        "name": "Schmoogle Inc."
      },
      "external_id": "ext_id_from_another_system012345",
      "family": {
        "id": "cac-ab12C345DeF6",
        "name": "Sumner Family"
      },
      "id": "creg-ab12C345DeF6",
      "is_subscriber": true,
      "type": "spouse"
    }
  ],
  "suffix": "Jr.",
  "terms_accepted": false,
  "terms_accepted_at": null,
  "updated_at": null,
  "uses_tobacco": false
}
{
  "account": {
    "name": "Name on the billing account",
    "past_due_in_cents": "Amount past due in cents"
  },
  "address_city": "City of the patient's address",
  "address_country": "Country of the patient's address",
  "address_line1": "First line of the patient's address",
  "address_line2": "Second line of the patient's address",
  "address_state": "State of the patient's address",
  "address_zip": "ZIP code of the patient's address",
  "age": "Age of the patient",
  "chosen_first_name": "Patient's chosen or preferred first name",
  "chosen_last_name": "Patient's chosen or preferred last name",
  "chosen_middle_name": "Patient's chosen or preferred middle name",
  "chosen_suffix": "Patient's chosen or preferred suffix",
  "chosen_title": "Patient's chosen or preferred title",
  "company": {
    "id": "Unique identifier for the company",
    "name": "Name of the company"
  },
  "created_at": "Timestamp when the patient record was created",
  "dob": "Patient's date of birth",
  "electronic_communication_consent_accepted": "Whether the patient accepted electronic communication consent",
  "electronic_communication_consent_accepted_at": "Timestamp when the patient accepted electronic communication consent",
  "email": "Patient's email address",
  "external_link_id": "External link identifier for the patient",
  "external_records": {
    "external_id": "External identifier in the source system",
    "source": "Source system of the external record"
  },
  "first_name": "Patient's first name",
  "gender": "Patient's gender",
  "gender_identity": "Patient's gender identity",
  "gender_other": "Patient's gender if not covered by standard options",
  "health_insurance_group_id": "Health insurance group ID",
  "health_insurance_member_id": "Health insurance member ID",
  "health_insurance_payer_id": "Health insurance payer ID",
  "health_insurance_payer_name": "Health insurance payer name",
  "hipaa_authorization_accepted": "Whether the patient accepted the HIPAA authorization",
  "hipaa_authorization_accepted_at": "Timestamp when the patient accepted the HIPAA authorization",
  "id": "Unique identifier for the patient",
  "import_id": "Import batch identifier",
  "import_source": "Source system of the import",
  "joined_practice_date": "Date the patient joined the practice",
  "known_practice": {
    "id": "Unique identifier for the known practice",
    "name": "Name of the known practice"
  },
  "last_name": "Patient's last name",
  "lead_source": {
    "created_at": "Timestamp when the lead source was created",
    "id": "Unique identifier for the lead source",
    "name": "Name of the lead source",
    "updated_at": "Timestamp when the lead source was last updated"
  },
  "lead_source_other": "Description of the lead source when 'Other' is selected",
  "location": {
    "address_city": "City of the location's address",
    "address_country": "Country of the location's address",
    "address_latitude": "Latitude of the location's address",
    "address_line1": "First line of the location's address",
    "address_line2": "Second line of the location's address",
    "address_longitude": "Longitude of the location's address",
    "address_state": "State of the location's address",
    "address_zip": "ZIP code of the location's address",
    "distance": "Distance from the patient to the location",
    "id": "Unique identifier for the location",
    "location_group": {
      "created_at": "Timestamp when the location group was created",
      "id": "Unique identifier for the location group",
      "integration_record_id": "Integration record identifier for the location group",
      "name": "Name of the location group",
      "updated_at": "Timestamp when the location group was last updated"
    },
    "name": "Name of the location",
    "phone_number": "Phone number of the location",
    "virtual": "Whether the location is virtual"
  },
  "location_group": {
    "created_at": "Timestamp when the location group was created",
    "id": "Unique identifier for the location group",
    "integration_record_id": "Integration record identifier for the location group",
    "name": "Name of the location group",
    "updated_at": "Timestamp when the location group was last updated"
  },
  "master_record_sponsor": "Master record sponsor identifier",
  "membership_status": "Current membership status of the patient",
  "memberships": {
    "company": {
      "id": "Unique identifier for the company",
      "name": "Name of the company"
    },
    "division": {
      "id": "Unique identifier for the division",
      "name": "Name of the division"
    },
    "end_date": "End date of the membership",
    "enrollment_requested_on": "Date when enrollment was requested",
    "enrollment_status": "Current enrollment status",
    "member_type": "Type of membership (e.g., employee, spouse, dependent)",
    "payer": {
      "id": "Unique identifier for the payer",
      "name": "Name of the payer"
    },
    "plan": {
      "id": "Unique identifier for the plan",
      "name": "Name of the plan"
    },
    "start_date": "Start date of the membership",
    "status": "Current status of the membership",
    "uses_tobacco": "Whether the member uses tobacco"
  },
  "merged_into": {
    "id": "Unique identifier of the patient record this was merged into",
    "name": "Name of the patient record this was merged into"
  },
  "middle_name": "Patient's middle name",
  "name": "Patient's full name",
  "patient_agreement_accepted": "Whether the patient accepted the patient agreement",
  "patient_agreement_accepted_at": "Timestamp when the patient accepted the patient agreement",
  "phones": {
    "number": "Phone number",
    "type": "Type of phone number (e.g., mobile, home, work)"
  },
  "practitioner": {
    "accepts_enrollments_from_employer": "Whether the practitioner accepts enrollments from employers",
    "accepts_enrollments_from_retail": "Whether the practitioner accepts enrollments from retail",
    "bio": "Practitioner's biography",
    "created_at": "Timestamp when the practitioner record was created",
    "education": "Practitioner's education background",
    "email": "Practitioner's email address",
    "gender": "Practitioner's gender",
    "gender_other": "Practitioner's gender if not covered by standard options",
    "id": "Unique identifier for the practitioner",
    "integration_record_id": "Integration record identifier for the practitioner",
    "locations": {
      "address_city": "City of the location's address",
      "address_country": "Country of the location's address",
      "address_latitude": "Latitude of the location's address",
      "address_line1": "First line of the location's address",
      "address_line2": "Second line of the location's address",
      "address_longitude": "Longitude of the location's address",
      "address_state": "State of the location's address",
      "address_zip": "ZIP code of the location's address",
      "distance": "Distance from the patient to the location",
      "id": "Unique identifier for the location",
      "location_group": {
        "created_at": "Timestamp when the location group was created",
        "id": "Unique identifier for the location group",
        "integration_record_id": "Integration record identifier for the location group",
        "name": "Name of the location group",
        "updated_at": "Timestamp when the location group was last updated"
      },
      "name": "Name of the location",
      "phone_number": "Phone number of the location",
      "virtual": "Whether the location is virtual"
    },
    "max_patient_age": "Maximum patient age the practitioner serves",
    "min_patient_age": "Minimum patient age the practitioner serves",
    "name": "Practitioner's full name",
    "npi": {
      "id": "NPI number",
      "name": "Name associated with the NPI"
    },
    "online_signup_visibility": "Practitioner's visibility for online signup",
    "panel_size": "Current number of patients in the practitioner's panel",
    "panel_size_limit": "Maximum number of patients allowed in the practitioner's panel",
    "photo_url": "URL to the practitioner's photo",
    "specialties": {
      "id": "Unique identifier for the specialty",
      "name": "Name of the specialty"
    },
    "updated_at": "Timestamp when the practitioner record was last updated"
  },
  "practitioner_group": {
    "created_at": "Timestamp when the practitioner group was created",
    "id": "Unique identifier for the practitioner group",
    "integration_record_id": "Integration record identifier for the practitioner group",
    "name": "Name of the practitioner group",
    "updated_at": "Timestamp when the practitioner group was last updated"
  },
  "preferred_language": "Patient's preferred language",
  "pronouns": "Patient's preferred pronouns",
  "provider_web_link": "URL link to the patient's profile in the provider portal",
  "sex": "Patient's biological sex",
  "sponsorships": {
    "company": {
      "id": "Unique identifier for the company",
      "name": "Name of the company"
    },
    "external_id": "External identifier from another system",
    "family": {
      "id": "Unique identifier for the family",
      "name": "Name of the family"
    },
    "id": "Unique identifier for the sponsorship",
    "is_subscriber": "Whether this person is the subscriber",
    "type": "Type of sponsorship (e.g., employee, spouse, dependent)"
  },
  "suffix": "Patient's name suffix",
  "terms_accepted": "Whether the patient accepted the terms of service",
  "terms_accepted_at": "Timestamp when the patient accepted the terms of service",
  "updated_at": "Timestamp when the patient record was last updated",
  "uses_tobacco": "Whether the patient uses tobacco"
}

Payload Field Details

Patient
Event Payload