Organization Management
This section covers the settings that shape how your organization connects to HealthEx: getting notified when things change, signing patients in with your own identity provider, sending patients back to your app after a flow, and tracking your usage.
Before you start
Everything in this section requires the Org Admin permission. Settings are managed in the HealthEx Admin console, and the Usage APIs also require an access token; see Authentication.
Webhooks
Get notified the moment something happens, such as a patient withdrawing consent, instead of polling for changes.
- Webhooks Overview: how delivery works and what you can subscribe to
- Setting Up a Webhook: register an endpoint and send a test event
- Verifying Signatures: confirm each delivery came from HealthEx
- Retries and Failures: what counts as success and how retries work
- Idempotency and Ordering: handle duplicate and out-of-order events
- Troubleshooting: read the delivery log and rotate signing secrets
consent.withdrawn: the event sent when a patient revokes consent
Patient sign-in and redirects
Control how patients enter and leave the HealthEx consent flow.
- Setting Up Federated Login: let patients start the flow already signed in with your identity provider
- Setting Up a Hosted Redirect: send patients back to your app when they finish or decline
Usage
- Usage: retrieve document retrieval queries and monthly active users for reporting and reconciliation