Currently supported subscriptions
| resource_type | event | description |
|---|---|---|
| Adjustment | adjustment_created | Fires when adjustment is created. |
| Adjustment | adjustment_updated | Fires when adjustment is updated. |
| Adjustment | adjustment_deleted | Fires when adjustment is deleted. |
| AdjustmentTransaction | adjustment_transaction_insertion | Fires when adjustment transaction is inserted. |
| Appointment | appointment_insertion | Fires upon acomplete or failed response when inserting an appointment into the health record system. |
| Appointment | appointment_created | Fires when NexHealth detects a new appointment in the health record system. |
| Appointment | appointment_updated | Fires when NexHealth detects a change to an appointment object in the health record system. |
| Appointment | appointment_requested | Fires when NexHealth detects a new appointment has been requested but not (yet) inserted into the health record system. This is only for offices using the NexHealth webapp without an integrated health record system. |
| AdjustmentType | adjustment_type_created | Fires when adjustment type is created. |
| AdjustmentType | adjustment_type_updated | Fires when adjustment type is updated. |
| Charge | charge_created | Fires when charge is created. |
| Charge | charge_updated | Fires when charge is updated. |
| Charge | charge_deleted | Fires when charge is deleted. |
| Claim | claim_created | Fires when claim is created. |
| Claim | claim_updated | Fires when claim is updated. |
| Claim | claim_deleted | Fires when claim is deleted. |
| Conversation | conversation_created | Fires when conversation is created. |
| Conversation | conversation_updated | Fires when conversation is updated. |
| FeeSchedule | fee_schedule_created | Fires when fee schedule is created. |
| FeeSchedule | fee_schedule_updated | Fires when fee schedule is updated. |
| FormRequest | form_request_completed | Fires when a patient submits a completed form. |
| FormResponse | form_response_insertion | Fires upon a complete or failed response when inserting a form into the health record system. |
| Message | message_created | Fires when message is created. |
| Message | message_updated | Fires when message is updated. |
| Patient | patient_created | Fires when NexHealth detects a new patient has been created in the health record system. |
| Patient | patient_updated | Fires when NexHealth detects a change to a patient object. |
| PatientInsuranceCoverage | patient_insurance_created | Fires when patient insurance is created. |
| PatientInsuranceCoverage | patient_insurance_updated | Fires when patient insurance is updated. |
| Payment | payment_created | Fires when payment is created. |
| Payment | payment_updated | Fires when payment is updated. |
| Payment | payment_deleted | Fires when payment is deleted. |
| PaymentTransaction | payment_transaction_insertion | Fires when payment transaction is inserted. |
| PaymentType | payment_type_created | Fires when payment type is created. |
| PaymentType | payment_type_updated | Fires when payment type is updated. |
| Procedure | procedure_created | Fires when NexHealth detects a new procedure has been created in the health record system. |
| Procedure | procedure_updated | Fires when NexHealth detects a change to a procedure object in the health record system (ex: status from scheduled to completed or inactive). |
| SyncStatus | sync_status_read_change | Fires when an integration's read functionality status changes from red to green (in other words, when reads functionality comes back online). Currently, the webhook does not trigger from green to red. Instead, we recommend using the read_status_at field from the sync status endpoint response to determine the last successful read timestamp. Keep in mind that outside business hours—especially on weekends and holidays—the read_status_at value may show a delay of several hours or days. |
| SyncStatus | sync_status_write_change | Fires when an integration's write status changes from red to green (in other words, when writes functionality comes back online). Currently, the webhook does not trigger from green to red. Instead, we recommend using the write_status_at field from the sync status endpoint response to determine the last successful write timestamp. Keep in mind that outside business hours—especially on weekends and holidays—the write_status_at value may show a delay of several hours or days. |
You can find example payloads for each subscription below.
Adjustment
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Adjustment",
"event_name": "adjustment_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"adjustments": [
{
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"deleted_at": "2024-09-15T11:21:26.003Z",
"adjustment_amount": {
"amount": "62.00",
"currency": "USD"
},
"adjusted_at": "2024-10-01",
"charge_id": 1111,
"claim_id": 2222,
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"provider": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"display_name": "John Smith",
"npi": "1912507500",
"tin": "078051120",
"state_license": "R219935",
"specialty_code": "363L00000X",
"nexhealth_specialty": null,
"profile_url": null
},
"guarantor": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"adjustment_type_id": 5
}
]
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Adjustment",
"event_name": "adjustment_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"adjustment": {
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"deleted_at": "2024-09-15T11:21:26.003Z",
"adjustment_amount": {
"amount": "62.00",
"currency": "USD"
},
"adjusted_at": "2024-10-01",
"charge_id": 1111,
"claim_id": 2222,
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"provider": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"display_name": "John Smith",
"npi": "1912507500",
"tin": "078051120",
"state_license": "R219935",
"specialty_code": "363L00000X",
"nexhealth_specialty": null,
"profile_url": null
},
"guarantor": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"adjustment_type_id": 5
},
"previous_attributes": {
"description": "This is old description"
}
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Adjustment",
"event_name": "adjustment_deleted",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"adjustments": [
{
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"deleted_at": "2024-09-15T11:21:26.003Z",
"adjustment_amount": {
"amount": "62.00",
"currency": "USD"
},
"adjusted_at": "2024-10-01",
"charge_id": 1111,
"claim_id": 2222
}
]
}
}
AdjustmentTransaction
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "AdjustmentTransaction",
"event_name": "adjustment_transaction_insertion",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"adjustment_transaction": {
"patient_id": 3,
"value": {
"amount": "62.00",
"currency": "USD"
},
"adjusted_at": "2020-06-05T20:16:57.007Z",
"notes": null,
"transaction_id": "NHP:123456",
"adjustment_type_id": 1,
"charge_splits": {
"1": "-25.00",
"2": "-25.00"
},
"provider_splits": {
"1": "-25.00",
"2": "-25.00"
}
}
}
}
Appointment
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Appointment",
"event_name": "appointment_insertion.complete",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"appointment": {
"id": 1822,
"patient_id": 2897,
"provider_id": 104,
"provider_name": "Dr. John Smith",
"start_time": "2020-06-05T20:16:57.007Z",
"confirmed": true,
"patient_missed": false,
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"note": "Patient has been having a cough for 3 days",
"end_time": "2020-06-05T20:16:57.007Z",
"unavailable": false,
"cancelled": false,
"timezone": "America/New_York",
"institution_id": 1,
"appointment_type_id": 0,
"checkin_at": null,
"location_id": 1,
"foreign_id": "94",
"foreign_id_type": "msg-dentrix-DataSource-100",
"misc": {
"is_booked_on_nexhealth": true
},
"last_sync_time": "2020-06-05T20:16:57.007Z",
"patient_confirmed": 0,
"created_by_user_id": 197,
"is_guardian": false,
"patient_confirmed_at": null,
"cancelled_at": null,
"is_new_clients_patient": false,
"confirmed_at": null,
"sooner_if_possible": null,
"operatory_id": 181,
"deleted": false,
"checked_out": false,
"checked_out_at": null,
"referrer": "http://mypractice.com/book",
"is_past_patient": true,
"timezone_offset": "-4:00"
}
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Appointment",
"event_name": "appointment_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"appointments": [
{
"id": 1822,
"patient_id": 2897,
"provider_id": 104,
"provider_name": "Dr. John Smith",
"start_time": "2020-06-05T20:16:57.007Z",
"confirmed": true,
"patient_missed": false,
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"note": "Patient has been having a cough for 3 days",
"end_time": "2020-06-05T20:16:57.007Z",
"unavailable": false,
"cancelled": false,
"timezone": "America/New_York",
"institution_id": 1,
"appointment_type_id": 0,
"checkin_at": null,
"location_id": 1,
"foreign_id": "94",
"foreign_id_type": "msg-dentrix-DataSource-100",
"misc": {
"is_booked_on_nexhealth": true
},
"last_sync_time": "2020-06-05T20:16:57.007Z",
"patient_confirmed": 0,
"created_by_user_id": 197,
"is_guardian": false,
"patient_confirmed_at": null,
"cancelled_at": null,
"is_new_clients_patient": false,
"confirmed_at": null,
"sooner_if_possible": null,
"operatory_id": 181,
"deleted": false,
"checked_out": false,
"checked_out_at": null,
"referrer": "http://mypractice.com/book",
"is_past_patient": true,
"timezone_offset": "-4:00",
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es",
"guarantor": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null
},
"location_ids": [
101,
102,
103
],
"address": {
"line_1": null,
"line_2": null,
"postal_code": null,
"city": null,
"region": null
}
},
"descriptors": [
{
"id": 1822,
"descriptor_type": "Procedure Code",
"name": "Emr Descriptor Name",
"code": "Emr Descriptor Code",
"location_id": 13,
"foreign_id": "94",
"foreign_id_type": "msg-dentrix-DataSource-100",
"data": {},
"active": true,
"last_sync_time": "2021-05-21T16:23:03.046Z",
"created_at": "2021-05-21T16:23:03.046Z",
"updated_at": "2021-05-21T16:23:03.046Z"
}
]
}
]
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Appointment",
"event_name": "appointment_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"appointment": {
"id": 1822,
"patient_id": 2897,
"provider_id": 104,
"provider_name": "Dr. John Smith",
"start_time": "2020-06-05T20:16:57.007Z",
"confirmed": true,
"patient_missed": false,
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"note": "Patient has been having a cough for 3 days",
"end_time": "2020-06-05T20:16:57.007Z",
"unavailable": false,
"cancelled": false,
"timezone": "America/New_York",
"institution_id": 1,
"appointment_type_id": 0,
"checkin_at": null,
"location_id": 1,
"foreign_id": "94",
"foreign_id_type": "msg-dentrix-DataSource-100",
"misc": {
"is_booked_on_nexhealth": true
},
"last_sync_time": "2020-06-05T20:16:57.007Z",
"patient_confirmed": 0,
"created_by_user_id": 197,
"is_guardian": false,
"patient_confirmed_at": null,
"cancelled_at": null,
"is_new_clients_patient": false,
"confirmed_at": null,
"sooner_if_possible": null,
"operatory_id": 181,
"deleted": false,
"checked_out": false,
"checked_out_at": null,
"referrer": "http://mypractice.com/book",
"is_past_patient": true,
"timezone_offset": "-4:00",
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es",
"guarantor": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null
},
"location_ids": [
101,
102,
103
],
"address": {
"line_1": null,
"line_2": null,
"postal_code": null,
"city": null,
"region": null
}
},
"descriptors": [
{
"id": 1822,
"descriptor_type": "Procedure Code",
"name": "Emr Descriptor Name",
"code": "Emr Descriptor Code",
"location_id": 13,
"foreign_id": "94",
"foreign_id_type": "msg-dentrix-DataSource-100",
"data": {},
"active": true,
"last_sync_time": "2021-05-21T16:23:03.046Z",
"created_at": "2021-05-21T16:23:03.046Z",
"updated_at": "2021-05-21T16:23:03.046Z"
}
]
},
"previous_attributes": {
"confirmed": false,
"created_at": null
}
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Appointment",
"event_name": "appointment_requested",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"appointments": [
{
"id": 1822,
"patient_id": 2897,
"provider_id": 104,
"provider_name": "Dr. John Smith",
"start_time": "2020-06-05T20:16:57.007Z",
"confirmed": true,
"patient_missed": false,
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"note": "Patient has been having a cough for 3 days",
"end_time": "2020-06-05T20:16:57.007Z",
"unavailable": false,
"cancelled": false,
"timezone": "America/New_York",
"institution_id": 1,
"appointment_type_id": 0,
"checkin_at": null,
"location_id": 1,
"foreign_id": "94",
"foreign_id_type": "msg-dentrix-DataSource-100",
"misc": {
"is_booked_on_nexhealth": true
},
"last_sync_time": "2020-06-05T20:16:57.007Z",
"patient_confirmed": 0,
"created_by_user_id": 197,
"is_guardian": false,
"patient_confirmed_at": null,
"cancelled_at": null,
"is_new_clients_patient": false,
"confirmed_at": null,
"sooner_if_possible": null,
"operatory_id": 181,
"deleted": false,
"checked_out": false,
"checked_out_at": null,
"referrer": "http://mypractice.com/book",
"is_past_patient": true,
"timezone_offset": "-4:00",
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es",
"guarantor": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null
},
"location_ids": [
101,
102,
103
],
"address": {
"line_1": null,
"line_2": null,
"postal_code": null,
"city": null,
"region": null
}
},
"descriptors": [
{
"id": 1822,
"descriptor_type": "Procedure Code",
"name": "Emr Descriptor Name",
"code": "Emr Descriptor Code",
"location_id": 13,
"foreign_id": "94",
"foreign_id_type": "msg-dentrix-DataSource-100",
"data": {},
"active": true,
"last_sync_time": "2021-05-21T16:23:03.046Z",
"created_at": "2021-05-21T16:23:03.046Z",
"updated_at": "2021-05-21T16:23:03.046Z"
}
]
}
]
}
}
AdjustmentType
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "AdjustmentType",
"event_name": "adjustment_type_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"adjustment_types": [
{
"id": 113,
"name": "Cash",
"action": "credit"
}
]
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "AdjustmentType",
"event_name": "adjustment_type_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"adjustment_type": {
"id": 113,
"name": "Cash",
"action": "credit"
},
"previous_attributes": {
"name": "Card"
}
}
}
Charge
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Charge",
"event_name": "charge_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"charges": [
{
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"procedure_id": "NHP:JXZEQ1234",
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"fee": {
"amount": "62.00",
"currency": "USD"
},
"charged_at": "2024-10-05",
"deleted_at": "2022-01-01T00:00:00Z",
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"provider": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"display_name": "John Smith",
"npi": "1912507500",
"tin": "078051120",
"state_license": "R219935",
"specialty_code": "363L00000X",
"nexhealth_specialty": null,
"profile_url": null
},
"guarantor": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null
},
"claim_payouts": [
{
"amount_billed_to_insurance": {
"amount": "62.00",
"currency": "USD"
},
"estimated_insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"claim_id": 1234
}
],
"claims": [
{
"id": 10,
"location_id": 1,
"patient_id": 1002,
"provider_id": 101,
"guarantor_id": 1001,
"status": "sent",
"received_at": "2024-06-10T15:16:57.000Z",
"sent_at": "2024-06-03T11:23:12.000Z",
"note": "Claim was sent to the insurance company",
"primary_insurance_plan_id": 10021,
"secondary_insurance_plan_id": 10021,
"date_of_service": "2024-06-03",
"totals": {
"amount_billed_to_insurance": {
"amount": "62.00",
"currency": "USD"
},
"estimated_insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"write_off": {
"amount": "62.00",
"currency": "USD"
}
}
}
]
}
]
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Charge",
"event_name": "charge_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"charge": {
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"procedure_id": "NHP:JXZEQ1234",
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"fee": {
"amount": "62.00",
"currency": "USD"
},
"charged_at": "2024-10-05",
"deleted_at": "2022-01-01T00:00:00Z",
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"provider": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"display_name": "John Smith",
"npi": "1912507500",
"tin": "078051120",
"state_license": "R219935",
"specialty_code": "363L00000X",
"nexhealth_specialty": null,
"profile_url": null
},
"guarantor": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null
},
"claim_payouts": [
{
"amount_billed_to_insurance": {
"amount": "62.00",
"currency": "USD"
},
"estimated_insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"claim_id": 1234
}
],
"claims": [
{
"id": 10,
"location_id": 1,
"patient_id": 1002,
"provider_id": 101,
"guarantor_id": 1001,
"status": "sent",
"received_at": "2024-06-10T15:16:57.000Z",
"sent_at": "2024-06-03T11:23:12.000Z",
"note": "Claim was sent to the insurance company",
"primary_insurance_plan_id": 10021,
"secondary_insurance_plan_id": 10021,
"date_of_service": "2024-06-03",
"totals": {
"amount_billed_to_insurance": {
"amount": "62.00",
"currency": "USD"
},
"estimated_insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"write_off": {
"amount": "62.00",
"currency": "USD"
}
}
}
]
},
"previous_attributes": {
"description": "This is old description"
}
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Charge",
"event_name": "charge_deleted",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"charges": [
{
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"procedure_id": "NHP:JXZEQ1234",
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"fee": {
"amount": "62.00",
"currency": "USD"
},
"charged_at": "2024-10-05",
"deleted_at": "2022-01-01T00:00:00Z"
}
]
}
}
Claim
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Claim",
"event_name": "claim_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"claims": [
{
"id": 10,
"location_id": 1,
"patient_id": 1002,
"provider_id": 101,
"guarantor_id": 1001,
"status": "sent",
"received_at": "2024-06-10T15:16:57.000Z",
"sent_at": "2024-06-03T11:23:12.000Z",
"note": "Claim was sent to the insurance company",
"primary_insurance_plan_id": 10021,
"secondary_insurance_plan_id": 10021,
"date_of_service": "2024-06-03",
"totals": {
"amount_billed_to_insurance": {
"amount": "62.00",
"currency": "USD"
},
"estimated_insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"write_off": {
"amount": "62.00",
"currency": "USD"
}
},
"deleted_at": "2022-01-01T00:00:00Z",
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"provider": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"display_name": "John Smith",
"npi": "1912507500",
"tin": "078051120",
"state_license": "R219935",
"specialty_code": "363L00000X",
"nexhealth_specialty": null,
"profile_url": null
},
"guarantor": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null
},
"charge_payouts": [
{
"amount_billed_to_insurance": {
"amount": "62.00",
"currency": "USD"
},
"estimated_insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"charge_id": 1234
}
],
"charges": [
{
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"procedure_id": "NHP:JXZEQ1234",
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"fee": {
"amount": "62.00",
"currency": "USD"
},
"charged_at": "2024-10-05"
}
]
}
]
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Claim",
"event_name": "claim_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"claim": {
"id": 10,
"location_id": 1,
"patient_id": 1002,
"provider_id": 101,
"guarantor_id": 1001,
"status": "sent",
"received_at": "2024-06-10T15:16:57.000Z",
"sent_at": "2024-06-03T11:23:12.000Z",
"note": "Claim was sent to the insurance company",
"primary_insurance_plan_id": 10021,
"secondary_insurance_plan_id": 10021,
"date_of_service": "2024-06-03",
"totals": {
"amount_billed_to_insurance": {
"amount": "62.00",
"currency": "USD"
},
"estimated_insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"write_off": {
"amount": "62.00",
"currency": "USD"
}
},
"deleted_at": "2022-01-01T00:00:00Z",
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"provider": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"display_name": "John Smith",
"npi": "1912507500",
"tin": "078051120",
"state_license": "R219935",
"specialty_code": "363L00000X",
"nexhealth_specialty": null,
"profile_url": null
},
"guarantor": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null
},
"charge_payouts": [
{
"amount_billed_to_insurance": {
"amount": "62.00",
"currency": "USD"
},
"estimated_insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"charge_id": 1234
}
],
"charges": [
{
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"procedure_id": "NHP:JXZEQ1234",
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"fee": {
"amount": "62.00",
"currency": "USD"
},
"charged_at": "2024-10-05"
}
]
},
"previous_attributes": {
"status": "draft"
}
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Claim",
"event_name": "claim_deleted",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"claims": [
{
"id": 10,
"location_id": 1,
"patient_id": 1002,
"provider_id": 101,
"guarantor_id": 1001,
"status": "sent",
"received_at": "2024-06-10T15:16:57.000Z",
"sent_at": "2024-06-03T11:23:12.000Z",
"note": "Claim was sent to the insurance company",
"primary_insurance_plan_id": 10021,
"secondary_insurance_plan_id": 10021,
"date_of_service": "2024-06-03",
"totals": {
"amount_billed_to_insurance": {
"amount": "62.00",
"currency": "USD"
},
"estimated_insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"insurance_payment": {
"amount": "62.00",
"currency": "USD"
},
"write_off": {
"amount": "62.00",
"currency": "USD"
}
},
"deleted_at": "2022-01-01T00:00:00Z"
}
]
}
}
Conversation
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Conversation",
"event_name": "conversation_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"conversation": {
"id": 123,
"participant_count": 1,
"avatar": {
"type": null,
"value": "https://example.com/avatar.png"
},
"display_name": "John Smith",
"consolidated": false,
"preview_text": "Joe: What time do you close?",
"unsubscribed": false,
"hidden": false,
"messages": {
"id": "12345",
"sent_by": {
"name": "John Smith",
"user_id": 123,
"user_type": null,
"avatar": {
"type": null,
"value": "https://example.com/avatar.png"
}
},
"received_by": {
"name": "John Smith",
"user_id": 123,
"user_type": null,
"avatar": {
"type": null,
"value": "https://example.com/avatar.png"
}
},
"content": "What time do you close?",
"delivery_status": "delivered",
"attachments": {
"content_type": "image/png",
"file_name": "patient_information_form.pdf",
"url": "https://example.com/image.png"
}
},
"participants": {
"id": 415,
"email": "[email protected]",
"name": "John Smith",
"date_of_birth": "1964-05-03",
"gender": "Male",
"inactive": false,
"phone": "+12813308004"
}
}
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Conversation",
"event_name": "conversation_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"conversation": {
"id": 123,
"participant_count": 1,
"avatar": {
"type": null,
"value": "https://example.com/avatar.png"
},
"display_name": "John Smith",
"consolidated": false,
"preview_text": "Joe: What time do you close?",
"unsubscribed": false,
"hidden": false,
"messages": {
"id": "12345",
"sent_by": {
"name": "John Smith",
"user_id": 123,
"user_type": null,
"avatar": {
"type": null,
"value": "https://example.com/avatar.png"
}
},
"received_by": {
"name": "John Smith",
"user_id": 123,
"user_type": null,
"avatar": {
"type": null,
"value": "https://example.com/avatar.png"
}
},
"content": "What time do you close?",
"delivery_status": "delivered",
"attachments": {
"content_type": "image/png",
"file_name": "patient_information_form.pdf",
"url": "https://example.com/image.png"
}
},
"participants": {
"id": 415,
"email": "[email protected]",
"name": "John Smith",
"date_of_birth": "1964-05-03",
"gender": "Male",
"inactive": false,
"phone": "+12813308004"
}
},
"previous_attributes": {
"preview_text": "Joe: Hello"
}
}
}
FeeSchedule
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "FeeSchedule",
"event_name": "fee_schedule_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"fee_schedules": [
{
"id": 113,
"name": "Cash",
"active": null,
"location_id": null,
"procedure_fees": [
{
"procedure_code_id": "ab123456-11aa-99ff-a111-d1ee12345678",
"fee": {
"amount": "62.00",
"currency": "USD"
}
}
]
}
]
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "FeeSchedule",
"event_name": "fee_schedule_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"fee_schedule": {
"id": 113,
"name": "Cash",
"active": null,
"location_id": null,
"procedure_fees": [
{
"procedure_code_id": "ab123456-11aa-99ff-a111-d1ee12345678",
"fee": {
"amount": "62.00",
"currency": "USD"
}
}
]
},
"previous_attributes": {
"name": "Card"
},
"procedure_fees_changes": {
"updated": [
{
"procedure_code_id": 1234,
"fee": {
"amount": "30.00",
"currency": "USD"
}
}
],
"removed": [
{
"procedure_code_id": 1012,
"fee": {
"amount": "32.00",
"currency": "USD"
}
}
]
}
}
}
FormRequest
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "FormRequest",
"event_name": "form_request_completed",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"formrequest": {
"id": "d2594a76862247209d4c35a92e0902f8",
"location_id": 1,
"appointment_id": 1
}
}
}
FormResponse
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "FormResponse",
"event_name": "form_response_insertion.complete",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"formresponse": {
"id": 435,
"status": "complete",
"response_documents": [
{
"id": 435,
"pdf_url": "/api/documents/ee0913ee13af4e0aa4df2af1738d43d6.pdf"
}
],
"form_request_id": "d1b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
}
}
}
Message
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Message",
"event_name": "message_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"message": {
"id": "12345",
"sent_by": {
"name": "John Smith",
"user_id": 123,
"user_type": null,
"avatar": {
"type": null,
"value": "https://example.com/avatar.png"
}
},
"received_by": {
"name": "John Smith",
"user_id": 123,
"user_type": null,
"avatar": {
"type": null,
"value": "https://example.com/avatar.png"
}
},
"content": "What time do you close?",
"delivery_status": "delivered",
"attachments": {
"content_type": "image/png",
"file_name": "patient_information_form.pdf",
"url": "https://example.com/image.png"
}
}
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Message",
"event_name": "message_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"message": {
"id": "12345",
"sent_by": {
"name": "John Smith",
"user_id": 123,
"user_type": null,
"avatar": {
"type": null,
"value": "https://example.com/avatar.png"
}
},
"received_by": {
"name": "John Smith",
"user_id": 123,
"user_type": null,
"avatar": {
"type": null,
"value": "https://example.com/avatar.png"
}
},
"content": "What time do you close?",
"delivery_status": "delivered",
"attachments": {
"content_type": "image/png",
"file_name": "patient_information_form.pdf",
"url": "https://example.com/image.png"
}
},
"previous_attributes": {
"delivery_status": "queued"
}
}
}
Patient
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Patient",
"event_name": "patient_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"patients": [
{
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es",
"location_ids": [
1,
2,
3
]
}
]
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Patient",
"event_name": "patient_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es",
"location_ids": [
1,
2,
3
]
},
"previous_attributes": {
"inactive": true
}
}
}
PatientInsuranceCoverage
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "PatientInsuranceCoverage",
"event_name": "patient_insurance_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"patient_insurance_coverages": [
{
"id": 18,
"subscription_relation": "self",
"patient_id": 25,
"priority": 2,
"subscriber_num": "123456789",
"effective_date": "2022-01-01",
"expiration_date": "2022-12-31",
"insurance_type": "dental"
}
]
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "PatientInsuranceCoverage",
"event_name": "patient_insurance_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"patient_insurance_coverage": {
"id": 18,
"subscription_relation": "self",
"patient_id": 25,
"priority": 2,
"subscriber_num": "123456789",
"effective_date": "2022-01-01",
"expiration_date": "2022-12-31",
"insurance_type": "dental"
},
"previous_attributes": {
"priority": 1
}
}
}
Payment
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Payment",
"event_name": "payment_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"payments": [
{
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"deleted_at": "2024-09-15T11:21:26.003Z",
"payment_amount": {
"amount": "62.00",
"currency": "USD"
},
"paid_at": "2024-10-01",
"transaction_id": "NHP:JXZEQ1234",
"charge_id": 1111,
"claim_id": 2222,
"payment_plan_id": 3,
"insurance_plan_id": 4,
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"provider": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"display_name": "John Smith",
"npi": "1912507500",
"tin": "078051120",
"state_license": "R219935",
"specialty_code": "363L00000X",
"nexhealth_specialty": null,
"profile_url": null
},
"guarantor": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"payment_type_id": 5
}
]
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Payment",
"event_name": "payment_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"payment": {
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"deleted_at": "2024-09-15T11:21:26.003Z",
"payment_amount": {
"amount": "62.00",
"currency": "USD"
},
"paid_at": "2024-10-01",
"transaction_id": "NHP:JXZEQ1234",
"charge_id": 1111,
"claim_id": 2222,
"payment_plan_id": 3,
"insurance_plan_id": 4,
"patient": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"provider": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"display_name": "John Smith",
"npi": "1912507500",
"tin": "078051120",
"state_license": "R219935",
"specialty_code": "363L00000X",
"nexhealth_specialty": null,
"profile_url": null
},
"guarantor": {
"id": 415,
"email": "[email protected]",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": null,
"foreign_id": null,
"foreign_id_type": "--DataSource-",
"bio": {
"city": "New York",
"state": "NY",
"gender": "Female",
"zip_code": "20814",
"new_patient": false,
"non_patient": true,
"phone_number": "5163042196",
"date_of_birth": "1964-05-03",
"address_line_1": "",
"address_line_2": "",
"street_address": "",
"cell_phone_number": "",
"home_phone_number": "",
"work_phone_number": ""
},
"inactive": false,
"last_sync_time": null,
"guarantor_id": null,
"unsubscribe_sms": true,
"balance": {
"amount": "62.00",
"currency": "USD"
},
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es"
},
"payment_type_id": 5
},
"previous_attributes": {
"payment_amount": {
"amount": "60.00"
}
}
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Payment",
"event_name": "payment_deleted",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"payments": [
{
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"deleted_at": "2024-09-15T11:21:26.003Z",
"payment_amount": {
"amount": "62.00",
"currency": "USD"
},
"paid_at": "2024-10-01",
"transaction_id": "NHP:JXZEQ1234",
"charge_id": 1111,
"claim_id": 2222,
"payment_plan_id": 3,
"insurance_plan_id": 4
}
]
}
}
PaymentTransaction
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "PaymentTransaction",
"event_name": "payment_transaction_insertion",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"payment_transaction": {
"patient_id": 3,
"value": {
"amount": "62.00",
"currency": "USD"
},
"paid_at": "2020-06-05T20:16:57.007Z",
"notes": null,
"transaction_id": "NHP:123456",
"method": "card",
"charge_splits": {
"1": "-25.00",
"2": "-25.00"
},
"provider_splits": {
"1": "-25.00",
"2": "-25.00"
},
"type_name": "Credit Card"
}
}
}
PaymentType
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "PaymentType",
"event_name": "payment_type_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"payment_types": [
{
"id": 113,
"name": "Cash"
}
]
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "PaymentType",
"event_name": "payment_type_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"payment_type": {
"id": 113,
"name": "Cash"
},
"previous_attributes": {
"name": "Card"
}
}
}
Procedure
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Procedure",
"event_name": "procedure_created",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"procedures": [
{
"id": 11,
"location_id": 21,
"patient_id": 162,
"provider_id": 84,
"appointment_id": 283,
"code": "D6100",
"name": "Implant Removal",
"status": "referred",
"body_site": null,
"fee": {
"amount": "62.00",
"currency": "USD"
},
"start_date": "2022-06-24",
"end_date": "2022-06-24"
}
]
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "Procedure",
"event_name": "procedure_updated",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"procedure": {
"id": 11,
"location_id": 21,
"patient_id": 162,
"provider_id": 84,
"appointment_id": 283,
"code": "D6100",
"name": "Implant Removal",
"status": "referred",
"body_site": null,
"fee": {
"amount": "62.00",
"currency": "USD"
},
"start_date": "2022-06-24",
"end_date": "2022-06-24"
},
"previous_attributes": {
"status": "scheduled"
}
}
}
SyncStatus
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "SyncStatus",
"event_name": "sync_status_read_change.green",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"syncstatus": {
"institution_id": 1,
"sync_source_type": "DataSource",
"sync_source_name": "My Source",
"emr": {
"id": 11,
"name": "dentrix",
"display_name": "Dentrix",
"type": [
"cloud",
"onprem"
]
},
"read_status": "green",
"read_status_at": "2020-06-05T20:16:57.007Z",
"write_status": "red",
"write_status_at": "2020-06-05T20:16:57.007Z",
"locations": null
}
}
}
{
"institution_id": 1,
"subdomain": "test-subdomain",
"webhook_subscription_id": 2,
"resource_type": "SyncStatus",
"event_name": "sync_status_write_change.red",
"event_time": "2024-03-21T17:52:47.824Z",
"data": {
"syncstatus": {
"institution_id": 1,
"sync_source_type": "DataSource",
"sync_source_name": "My Source",
"emr": {
"id": 11,
"name": "dentrix",
"display_name": "Dentrix",
"type": [
"cloud",
"onprem"
]
},
"read_status": "green",
"read_status_at": "2020-06-05T20:16:57.007Z",
"write_status": "red",
"write_status_at": "2020-06-05T20:16:57.007Z",
"locations": null
}
}
}