Note: The Docus Lab API is in active development. Features and endpoints may be updated. Please refer to the latest API version in the official documentation for the most accurate information.
POST
request with event data to the configured webhook URL.200 OK
response to confirm receipt.Event Name | Description |
---|---|
report_ready | Triggered when a health report is available. |
report_dynamics_ready | Triggered when a health dynamics report is available. |
patient_notification | Sent when an AI-powered health notification is generated. |
POST
requests with a JSON payload.Header | Description |
---|---|
x-webhook-key | Partner's authentication key |
Content-Type | application/json |
{
"event": "patient_notification",
"timestamp": "2025-03-04T12:00:00Z",
"data": {
"patient_id": "12345",
"message": "Patient's cholesterol is high. A follow-up is recommended."
}
}
{
"status": "success",
"message": "Webhook received successfully."
}
Status Code | Meaning | Example Response |
---|---|---|
400 | Bad Request | { "error": "Invalid payload format" } |
401 | Unauthorized | { "error": "Invalid API key" } |
500 | Server Error | { "error": "Internal server issue" } |