Events
Triggering Webhook Types
The following event types are associated with the Policy event payload from Healthie.Healthie Policy CreatedHealthie Policy Updated
{
"benefits": [
{
"coinsurance": "15",
"copay": "50",
"deductible_calendar_year": "2000",
"deductible_year_to_date": "1500"
}
],
"effective_end": "2024-07-04",
"group_num": "331256",
"id": "202402",
"insurance_card_back_id": "123452",
"insurance_card_front_id": "123451",
"insurance_plan": {
"id": "611231",
"name_and_id": "Blue Cross Blue Shield - 629913",
"payer_id": "629913",
"payer_name": "Blue Cross Blue Shield"
},
"insurance_type": "Medicaid",
"notes": "Policy is active",
"num": "1912310",
"patient_id": "100121",
"priority_type": "Primary",
"updated_at": "2024-07-01T11:29:19+00:00"
}
{
"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"
}
Payload Field Details
Event Payload
Hide fields
Hide fields
object
Insurance plan details
CEL
insurance_plan
Example
{
"id": "611231",
"name_and_id": "Blue Cross Blue Shield - 629913",
"payer_id": "629913",
"payer_name": "Blue Cross Blue Shield"
}
string
ID of the insurance payer
CEL
insurance_plan.payer_id
Example
"629913"
string
Name of the insurance payer
CEL
insurance_plan.payer_name
Example
"Blue Cross Blue Shield"
string
ID of the insurance plan
CEL
insurance_plan.id
Example
"611231"
string
Name of the payer and id of payer
CEL
insurance_plan.name_and_id
Example
"Blue Cross Blue Shield - 629913"
string
PII Policy numberCEL
num
Example
"1912310"
string
Group number
CEL
group_num
Example
"331256"
string
Notes about the policy
CEL
notes
Example
"Policy is active"
values.v1.Date
Date the policy coverage expires
CEL
effective_end
Example
"2024-07-04"
string
required
ID for the policy
CEL
id
Example
"202402"
string
required
ID PII ID of the patient associated with the policyCEL
patient_id
Example
"100121"
string
HI ID PII ID of the insurance card front image objectCEL
insurance_card_front_id
Example
"123451"
string
HI ID PII ID of the insurance card back image objectCEL
insurance_card_back_id
Example
"123452"
timing.v1.Timestamp
required
Last time the Policy was updated
CEL
updated_at
Example
"2024-07-01T11:29:19+00:00"
string
The type of insurance:
type_stringCEL
insurance_type
Example
"Medicaid"
string
The priority type of insurance:
priority_typeCEL
priority_type
Example
"Primary"
[]object
required
Insurance plan details
CEL
benefits
Example
[
{
"coinsurance": "15",
"copay": "50",
"deductible_calendar_year": "2000",
"deductible_year_to_date": "1500"
}
]
[]string
required
Mapped array of: Coinsurance percentage due
CEL
benefits.map(x, x.coinsurance)
Example
[
"15"
]
[]string
required
Mapped array of: Copay amount due
CEL
benefits.map(x, x.copay)
Example
[
"50"
]
[]string
required
Mapped array of: Deductible amount for the calendar year
CEL
benefits.map(x, x.deductible_calendar_year)
Example
[
"2000"
]
[]string
required
Mapped array of: Deductible amount for the year to-date
CEL
benefits.map(x, x.deductible_year_to_date)
Example
[
"1500"
]