Skip to main content

​
Overview

Cair Health provides a webhook system that allows you to receive real-time notifications when patient chart analysis is completed. This enables you to integrate your systems with Cair Health and respond to analysis completion events as they happen. When a patient chart analysis is completed in the platform, whether triggered by UI or API, the system will automatically send the analysis results to your specified endpoint.

​
Setup

To enable webhook delivery for patient chart analysis:
  1. Navigate to your Developer Settings
  2. Go to the Webhooks section
  3. Create a new webhook with the following information:
    • URL: The endpoint where you want to receive webhook payloads
    • Event Type: Select PATIENT_CHART_ANALYSIS_COMPLETE
    • Description: A description for your reference
    • Credentials: Your preferred credentials set

​
Event Types

You can subscribe to the following event type for patient chart analysis:
Event TypeDescription
PATIENT_CHART_ANALYSIS_COMPLETEReceive notifications when chart analysis is completed

​
Authentication

For security, webhooks can be authenticated using API keys. When setting up your webhook, you can configure:
  • Authentication Type: Currently supports API_SECRET, HMAC-256
  • Header Name: The HTTP header that will contain your secret (e.g., X-API-KEY)
  • Secret: The secret value that will be sent with each webhook request

​
Payload Format

The webhook payload contains the complete analysis results in JSON format. To view the response format, see Fetch Patient Chart Report