Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.readyhealth.com/llms.txt

Use this file to discover all available pages before exploring further.

Webhooks allow you to receive real-time updates about results from the Ready Health API. When you are getting set up, you will specify a URL where you wish to receive the requests.

​
Webhook Payloads

The payload of a webhook will look like so: 
{
"type": <event_type>,
"data": {
          "documentId": <string>,
          "status": <status>,
        }
}

​
Event types

Event typeData.Status
SCAN_SUCCESSSUCCESS
SCAN_FAILEDFAILED
VALIDATION_SUCCESSVALID
VALIDATION_FAILEDINVALID