Webhooks
ModelsExpand Collapse
class ReportDeliveredEvent:Webhook event sent when a report is completed. This is an asynchronous notification - respond with a simple acknowledgment.
Webhook event sent when a report is completed. This is an asynchronous notification - respond with a simple acknowledgment.
Unique webhook event ID. Format: whe_{32-hex-chars}
required Data DataEvent payload containing report and study information
Event payload containing report and study information
Presigned URL for PDF download. Time-limited, typically valid for 1 hour.
Avara report ID. Format: rep_{32-hex-chars}
Avara study ID. Format: stu_{32-hex-chars}
Report plain text content (optional). Contains the full report text.
Event type identifier
class ReportDeliveredResponse:Response expected by Avara for report delivery webhook. Simple acknowledgment.
Response expected by Avara for report delivery webhook. Simple acknowledgment.
Acknowledgment of receipt. Return true to confirm delivery.
class StudyAccessRequestedEvent:Webhook event sent when Avara needs presigned URLs for DICOM images. This is a synchronous webhook - you must respond with the URLs within the request timeout.
Webhook event sent when Avara needs presigned URLs for DICOM images. This is a synchronous webhook - you must respond with the URLs within the request timeout.
Unique webhook event ID. Format: whe_{32-hex-chars}
required Data DataEvent payload containing study information
Event payload containing study information
Avara study ID. Format: stu_{32-hex-chars}
DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')
Event type identifier
class StudyAccessRequestedResponse:Response expected by Avara for study access webhook. Provide presigned URLs for DICOM images.
Response expected by Avara for study access webhook. Provide presigned URLs for DICOM images.
Whether access is authorized for this study
Flat list of presigned URLs for DICOM images. Include all image URLs for the study.
Error message if authorization failed or URLs cannot be provided
class WebhookEvent: A class that can be one of several variants.union Union of all Avara webhook event types. Use the 'type' field to discriminate between event types. Events: study.access_requested (synchronous), report.delivered (asynchronous).
Union of all Avara webhook event types. Use the 'type' field to discriminate between event types. Events: study.access_requested (synchronous), report.delivered (asynchronous).
class StudyAccessRequestedEvent:Webhook event sent when Avara needs presigned URLs for DICOM images. This is a synchronous webhook - you must respond with the URLs within the request timeout.
Webhook event sent when Avara needs presigned URLs for DICOM images. This is a synchronous webhook - you must respond with the URLs within the request timeout.
Unique webhook event ID. Format: whe_{32-hex-chars}
required Data DataEvent payload containing study information
Event payload containing study information
Avara study ID. Format: stu_{32-hex-chars}
DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')
Event type identifier
class ReportDeliveredEvent:Webhook event sent when a report is completed. This is an asynchronous notification - respond with a simple acknowledgment.
Webhook event sent when a report is completed. This is an asynchronous notification - respond with a simple acknowledgment.
Unique webhook event ID. Format: whe_{32-hex-chars}
required Data DataEvent payload containing report and study information
Event payload containing report and study information
Presigned URL for PDF download. Time-limited, typically valid for 1 hour.
Avara report ID. Format: rep_{32-hex-chars}
Avara study ID. Format: stu_{32-hex-chars}
Report plain text content (optional). Contains the full report text.
Event type identifier
class UnsafeUnwrapWebhookEvent: A class that can be one of several variants.union Webhook event sent when Avara needs presigned URLs for DICOM images. This is a synchronous webhook - you must respond with the URLs within the request timeout.
Webhook event sent when Avara needs presigned URLs for DICOM images. This is a synchronous webhook - you must respond with the URLs within the request timeout.
class StudyAccessRequestedEvent:Webhook event sent when Avara needs presigned URLs for DICOM images. This is a synchronous webhook - you must respond with the URLs within the request timeout.
Webhook event sent when Avara needs presigned URLs for DICOM images. This is a synchronous webhook - you must respond with the URLs within the request timeout.
Unique webhook event ID. Format: whe_{32-hex-chars}
required Data DataEvent payload containing study information
Event payload containing study information
Avara study ID. Format: stu_{32-hex-chars}
DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')
Event type identifier
class ReportDeliveredEvent:Webhook event sent when a report is completed. This is an asynchronous notification - respond with a simple acknowledgment.
Webhook event sent when a report is completed. This is an asynchronous notification - respond with a simple acknowledgment.
Unique webhook event ID. Format: whe_{32-hex-chars}
required Data DataEvent payload containing report and study information
Event payload containing report and study information
Presigned URL for PDF download. Time-limited, typically valid for 1 hour.
Avara report ID. Format: rep_{32-hex-chars}
Avara study ID. Format: stu_{32-hex-chars}
Report plain text content (optional). Contains the full report text.
Event type identifier