Webhooks
Webhook Notifications
Receive HIPAA-compliant real-time notifications for healthcare events.
HIPAA Compliant
Webhook payloads are encrypted and contain minimal PHI. Full patient data must be fetched via authenticated API calls.
Available Events
| Event | Description | Category |
|---|---|---|
patient.created | New patient registered | Patients |
patient.updated | Patient information changed | Patients |
appointment.scheduled | New appointment booked | Scheduling |
appointment.cancelled | Appointment cancelled | Scheduling |
encounter.started | Patient visit begun | Clinical |
encounter.completed | Visit documentation complete | Clinical |
result.available | Lab/test result ready | Clinical |
Webhook Payload
Example: appointment.scheduled
{
"id": "evt_health_123456",
"type": "appointment.scheduled",
"timestamp": "2024-12-04T10:30:00Z",
"data": {
"appointment_id": "appt_abc123",
"patient_id": "patient_xyz",
"provider_id": "provider_456",
"scheduled_time": "2024-12-10T14:00:00Z",
"visit_type": "follow_up"
}
}