Webhooks

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 type	Data.Status
SCAN_SUCCESS	`SUCCESS`
SCAN_FAILED	`FAILED`
VALIDATION_SUCCESS	`VALID`
VALIDATION_FAILED	`INVALID`

Scans

Searches

Statements

Utilities

Webhook Payloads

Event types

​Webhook Payloads

​Event types

Webhook Payloads

Event types