Webhooks are how Wendi pushes data to custom systems
Table of Contents
Configure Webhooks
To configure a Wendi Push Webhook, navigate to the Integrations section using the left hand menu. The section is located underneath My Organization.
From that section, click on the Webhooks tab. Then click the Configure Webhooks button.
This will open the corresponding Wendi Push Console for your Provider where you can add/manage endpoint integrations and view message logs. To configure a new endpoint, click the “Add Endpoint” button in the Endpoints tab.
This will open a screen where you can specify the endpoint URL you would like to send to. If you are exploring the Wendi Push service for the first time and would like to test it out prior to configuring your integration, click on the “Use Svix Play” to create a test webhook URL that makes it easy to inspect, test, and debug incoming webhooks with the Svix webhook playground & debugger.
Webhook Event Types
Wendi Push currently supports the following events:
- for appointments:
- appointment.booked
- appointment.cancelled
- appointment.confirmed
- appointment.rescheduled
- for patients:
- patient.created
- patient.updated
- patient.benefits
- patient.message
- patient.submitted_form
If you’d like to review logs for all Wendi Push messages, click on the “Logs” tab in the Wendi Push Console.
patient.submitted_form event
This event is sent when a patient completes a form, or submits a workflow step. It has the following schema outline:
{
birthdate_on: [String] (Patient birthdate in YYYY-MM-DD format)
contact_phone_number: [String] (10 digit phone number)
created_at: [Datetime String] (Patient created at)
first_name: [String] (Patient first name)
last_name: [String] (Patient last name)
form_data: [Object] (Contents of the completed form)
id: [Number] (Patient ID)
issues: [Array] (Array of issues patient has selected)
status: [String] (The patient's status in Wendi)
}
Note: inside the form_data
object is an id
attribute that is a unique ID for that set of form answers. Also inside form_data
is a patient_id
, which is the same as the id
attribute in the main event. This can be confusing.
patient.benefits event
This event is sent when an instant benefits check is complete. It has the following schema outline:
{
active_coverage: [Boolean]
benefits_data_271: [Object] (Details of the instant benefits check)
id: [Number] (This is the ID of the Benefits check run)
patient_id: [Number] (ID of the patient)
payer_id: [Number] (Internal Wendi ID of the Payer)
provider_id: [Number]
status: [String] (The patient's status in Wendi)
}
Patient Status Mapping
The values of the patient's status in the webhook map to the followving values in the Wendi UI:
Webhook Status | Dashboard Status |
LEAD | Inquiry |
PROSPECT | Prospect |
APPOINTMENT_PENDING | Appointment Pending |
IN_TREATMENT | Active Patient |
DISCHARGED | Discharged/Inactive |
WAIT_LIST | Wait List |
AMA | AMA |
REFERRED | Referred Out |
ARCHIVED | Archived |