Exam Webhook
POST
https://staging-api.qualiphy.me/api/{{PROVIDED_URL}}This endpoint is a webhook used to send information back after an exam invitation has been processed. This webhook is called by the system to notify the healthcare provider or relevant service about the status and details of the exam invite. It typically includes data such as the provider's name, clinic details, the exam name, status of the exam (e.g., Approved, Deferred, N/A), and unique identifiers like exam and patient exam IDs. This endpoint ensures that the provider receives real-time updates about the exam status, allowing for efficient follow-up and record-keeping within their systems.
Parameters
Response
200
Response Fields Explanation
| Field | Explanation |
|---|---|
| additional_data | This field returns the stringified data that was passed in during exam invite |
| questions_answers | You will receive an array of objects that include the question, answer and the position of the question |
| event | There are three potential times a webhook is called depending on the exam. Event 1 is general good faith exams. Event 2 represents exams with included prescriptions and will return back the prescription details. Event 3 will include prescription tracking information for those exams with prescriptive services |
Example Request Payload:
Response Example
{
"event":1
"reason":"Initial consultation complete"
"exam_id":"exam-001"
"exam_url":"https://exam.example.com/acces..."
"exam_name":"General Health Check"
"rx_status":"Pharmacy Confirmed"
"clinic_name":"Downtown Medical Center"
"exam_status":"Approved"
"patient_email":"john.doe@example.com"
"provider_name":"NP Liza Test"
"additional_data":"Additional details passed in f..."
"patient_exam_id":"patient-exam-789"
"questions_answers":[
0:{
"no":1
"answer":"I am feeling good."
"question":"How are you feeling today?"
}
1:{
"no":2
"answer":"None known."
"question":"Do you have any allergies?"
}
]
"patient_phone_number":"234567890"
}
Response Example
{
"clinic_name":"Qualiphy Noahs Medspa"
"event":2
"exam_id":1292
"exam_name":"States here test"
"exam_status":"Approved"
"exam_url":"https://d29tu1ox8kfrdk.cloudfr..."
"patient_email":"asad+test@qualiphy.me"
"patient_exam_id":149784
"patient_phone_number":"1112223377"
"prescribed_os_id":486
"prescription":[
0:{
"active_ingredient":""
"created_at":"2025-03-19T18:42:27.000Z"
"directions":"Local"
"dispense_number":""
"dosage_form_type":"Inj"
"drug_name":"Local Pharmacy Pickup Drug"
"duration_days":0
"gpi_number":""
"inactive_ingredient":""
"ndc_number":"2323232"
"pharmacy_contacts":[
0:{
"email":
"full_name":
"phone_number":
"role":
}
]
"pharmacy_name":"Choose Your Pharmacy"
"prescription_id":3320
"prescription_tracking":[
0:{
"delivery_service":
"pharmacy_location":
"rx_number":
"ship_carrier":
"tracking_number":
}
]
"quantity":"2"
"quantity_units":""
"refill_amount":0
"schedule_code":""
"size":"2mL"
"strength":"2mg"
}
]
"provider_name":"Operator asad"
"questions_answers":[
0:{
"answer":[
0:"test"
]
"answers":[
0:"test"
]
"id":18781
"no":1
"position":1
"question":"test"
"response_type":1
"responses":[]
}
]
"reason":"test"
"rx_status":"Pharmacy Confirmed"
}
Response Example
{
"event":3
"patient_exam_id":"patient-exam-789"
"prescription_id*":"12345"
"tracking_number":"123ABC456DEF"
"delivery_service":"Overnight"
"pharmacy_location":"Main Street Location"
"order_id":"1234567890"
}