Skip to content
Avara
Get started
API Reference

Webhooks

ModelsExpand Collapse
class ReportDeliveredEvent:

Webhook event sent when a report is completed. This is an asynchronous notification - respond with a simple acknowledgment.

String id

Unique webhook event ID. Format: whe_{32-hex-chars}

ReportDeliveredEventData data

Event payload containing report and study information

boolean isCritical

Whether the report was marked critical at sign-off.

String presignedUrl

Presigned URL for PDF download. Time-limited, typically valid for 1 hour.

formaturi
String reportId

Avara report ID. Format: rep_{32-hex-chars}

String studyId

Avara study ID. Format: stu_{32-hex-chars}

Optional<String> plainText

Report plain text content (optional). Contains the full report text.

JsonValue; type "report.delivered"constant"report.delivered"constant

Event type identifier

class ReportDeliveredEventData:

Event payload containing report and study information

boolean isCritical

Whether the report was marked critical at sign-off.

String presignedUrl

Presigned URL for PDF download. Time-limited, typically valid for 1 hour.

formaturi
String reportId

Avara report ID. Format: rep_{32-hex-chars}

String studyId

Avara study ID. Format: stu_{32-hex-chars}

Optional<String> plainText

Report plain text content (optional). Contains the full report text.

class ReportDeliveredResponse:

Response expected by Avara for report delivery webhook. Simple acknowledgment.

boolean success

Acknowledgment of receipt. Return true to confirm delivery.

class SecondaryCaptureAccessRequestedEvent:

Webhook event sent when Avara needs presigned UPLOAD URLs for a secondary capture DICOM. This is a synchronous webhook - you must respond with the upload URLs within the request timeout.

String id

Unique webhook event ID. Format: whe_{32-hex-chars}

SecondaryCaptureAccessRequestedEventData data

Event payload containing study + (optional) series/SOP information for a secondary capture upload

String studyId

Avara study ID. Format: stu_{32-hex-chars}

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

Optional<String> seriesInstanceUid

DICOM Series Instance UID generated for the new secondary capture series (when available).

Optional<String> sopInstanceUid

DICOM SOP Instance UID generated for the new secondary capture object (when available).

JsonValue; type "secondary_capture.access_requested"constant"secondary_capture.access_requested"constant

Event type identifier

class SecondaryCaptureAccessRequestedEventData:

Event payload containing study + (optional) series/SOP information for a secondary capture upload

String studyId

Avara study ID. Format: stu_{32-hex-chars}

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

Optional<String> seriesInstanceUid

DICOM Series Instance UID generated for the new secondary capture series (when available).

Optional<String> sopInstanceUid

DICOM SOP Instance UID generated for the new secondary capture object (when available).

class SecondaryCaptureAccessRequestedResponse:

Response expected by Avara for the secondary capture webhook. Provide presigned PUT URLs the viewer will upload the DICOM to.

boolean authorized

Whether the secondary capture upload is authorized for this study

List<String> uploadUrls

Presigned PUT URLs for uploading the secondary capture DICOM. The viewer uploads the same object to every URL.

Optional<String> contentCreatorName

Optional content creator name. Avara derives this server-side; this field is ignored if provided.

Optional<String> error

Error message if authorization failed or upload URLs cannot be provided

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.

String id

Unique webhook event ID. Format: whe_{32-hex-chars}

StudyAccessRequestedEventData data

Event payload containing study information

String studyId

Avara study ID. Format: stu_{32-hex-chars}

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

JsonValue; type "study.access_requested"constant"study.access_requested"constant

Event type identifier

class StudyAccessRequestedEventData:

Event payload containing study information

String studyId

Avara study ID. Format: stu_{32-hex-chars}

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

class StudyAccessRequestedMediaUrl:

Presigned URL for non-DICOM media (images, PDFs, videos)

String mimeType

MIME type of the media file (e.g., application/pdf, image/jpeg, video/mp4)

String url

Presigned URL to download the media file

formaturi
Optional<String> fileName

Optional display name for the media file

class StudyAccessRequestedResponse:

Response expected by Avara for study access webhook. Provide presigned URLs for DICOM images and optionally for non-DICOM media.

boolean authorized

Whether access is authorized for this study

List<String> urls

Flat list of presigned URLs for DICOM images. Include all image URLs for the study.

Optional<String> error

Error message if authorization failed or URLs cannot be provided

Optional<List<StudyAccessRequestedMediaUrl>> mediaUrls

Optional presigned URLs for non-DICOM media (images, PDFs, videos) associated with the study.

String mimeType

MIME type of the media file (e.g., application/pdf, image/jpeg, video/mp4)

String url

Presigned URL to download the media file

formaturi
Optional<String> fileName

Optional display name for the media file

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), secondary_capture.access_requested (synchronous).

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.

String id

Unique webhook event ID. Format: whe_{32-hex-chars}

StudyAccessRequestedEventData data

Event payload containing study information

String studyId

Avara study ID. Format: stu_{32-hex-chars}

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

JsonValue; type "study.access_requested"constant"study.access_requested"constant

Event type identifier

class ReportDeliveredEvent:

Webhook event sent when a report is completed. This is an asynchronous notification - respond with a simple acknowledgment.

String id

Unique webhook event ID. Format: whe_{32-hex-chars}

ReportDeliveredEventData data

Event payload containing report and study information

boolean isCritical

Whether the report was marked critical at sign-off.

String presignedUrl

Presigned URL for PDF download. Time-limited, typically valid for 1 hour.

formaturi
String reportId

Avara report ID. Format: rep_{32-hex-chars}

String studyId

Avara study ID. Format: stu_{32-hex-chars}

Optional<String> plainText

Report plain text content (optional). Contains the full report text.

JsonValue; type "report.delivered"constant"report.delivered"constant

Event type identifier

class SecondaryCaptureAccessRequestedEvent:

Webhook event sent when Avara needs presigned UPLOAD URLs for a secondary capture DICOM. This is a synchronous webhook - you must respond with the upload URLs within the request timeout.

String id

Unique webhook event ID. Format: whe_{32-hex-chars}

SecondaryCaptureAccessRequestedEventData data

Event payload containing study + (optional) series/SOP information for a secondary capture upload

String studyId

Avara study ID. Format: stu_{32-hex-chars}

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

Optional<String> seriesInstanceUid

DICOM Series Instance UID generated for the new secondary capture series (when available).

Optional<String> sopInstanceUid

DICOM SOP Instance UID generated for the new secondary capture object (when available).

JsonValue; type "secondary_capture.access_requested"constant"secondary_capture.access_requested"constant

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.

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.

String id

Unique webhook event ID. Format: whe_{32-hex-chars}

StudyAccessRequestedEventData data

Event payload containing study information

String studyId

Avara study ID. Format: stu_{32-hex-chars}

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

JsonValue; type "study.access_requested"constant"study.access_requested"constant

Event type identifier

class ReportDeliveredEvent:

Webhook event sent when a report is completed. This is an asynchronous notification - respond with a simple acknowledgment.

String id

Unique webhook event ID. Format: whe_{32-hex-chars}

ReportDeliveredEventData data

Event payload containing report and study information

boolean isCritical

Whether the report was marked critical at sign-off.

String presignedUrl

Presigned URL for PDF download. Time-limited, typically valid for 1 hour.

formaturi
String reportId

Avara report ID. Format: rep_{32-hex-chars}

String studyId

Avara study ID. Format: stu_{32-hex-chars}

Optional<String> plainText

Report plain text content (optional). Contains the full report text.

JsonValue; type "report.delivered"constant"report.delivered"constant

Event type identifier

class SecondaryCaptureAccessRequestedEvent:

Webhook event sent when Avara needs presigned UPLOAD URLs for a secondary capture DICOM. This is a synchronous webhook - you must respond with the upload URLs within the request timeout.

String id

Unique webhook event ID. Format: whe_{32-hex-chars}

SecondaryCaptureAccessRequestedEventData data

Event payload containing study + (optional) series/SOP information for a secondary capture upload

String studyId

Avara study ID. Format: stu_{32-hex-chars}

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

Optional<String> seriesInstanceUid

DICOM Series Instance UID generated for the new secondary capture series (when available).

Optional<String> sopInstanceUid

DICOM SOP Instance UID generated for the new secondary capture object (when available).

JsonValue; type "secondary_capture.access_requested"constant"secondary_capture.access_requested"constant

Event type identifier