> ## 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

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:

```json theme={null}
{
"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`   |