Skip to main content

Overview

Cair Health provides a webhook system that allows you to receive real-time notifications when a claim is processed by the Cair Scrubbing AI. This enables you to integrate your systems with Cair Health and synchronize your information with Cair. When a claim is finished scrubbing, whether through automated scrub or a scrub triggered manually, the webhook will automatically post the results to your 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 CLAIMS_AI_OPTIMIZER
    • 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:

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. Below is an example the structure of the response:
ai_generated_x12_837 will be a stringified-JSON of the FHIR Claim resource representing the encounter. edits will contain AI-generated modifications from the original claim including rationales.