Webhooks (Coming Soon)
Guardian Health webhook subscriptions are on the roadmap. Below is an overview of the planned functionality to help you prepare your infrastructure.
1. Introduction to Webhooks
Webhooks will enable Guardian Health to push real-time notifications when patient records, encounters, conditions, or documents change in connected EHRs.
2. Setting Up Webhook Endpoints
Plan for HTTPS endpoints that respond quickly with 2xx status codes. Guardian Health will retry failed deliveries with exponential backoff.
3. Securing Webhooks
- Validate HMAC signatures using secrets generated in the dashboard.
- Enforce IP allow lists to accept traffic only from Guardian Health.
- Log every delivery attempt and monitor for unusual patterns.
4. Event Types
Planned events include patient.updated, encounter.completed, condition.updated, procedure.completed, and document.available. Expect payloads to align with the schemas described in the API reference.
5. Testing Webhooks
A webhook simulator will be available in the Guardian Health dashboard to send sample events to your staging endpoints. You will be able to replay deliveries for debugging.