# Webhooks

## Domain Types

### Report Delivered Event

- `class ReportDeliveredEvent:`

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

  - `required string ID`

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

  - `required Data Data`

    Event payload containing report and study information

    - `required string PresignedUrl`

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

    - `required string ReportID`

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

    - `required string StudyID`

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

    - `string PlainText`

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

  - `JsonElement Type "report.delivered"constant`

    Event type identifier

### Report Delivered Response

- `class ReportDeliveredResponse:`

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

  - `required Boolean Success`

    Acknowledgment of receipt. Return true to confirm delivery.

### Study Access Requested Event

- `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.

  - `required string ID`

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

  - `required Data Data`

    Event payload containing study information

    - `required string StudyID`

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

    - `required 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')

  - `JsonElement Type "study.access_requested"constant`

    Event type identifier

### Study Access Requested Response

- `class StudyAccessRequestedResponse:`

  Response expected by Avara for study access webhook. Provide presigned URLs for DICOM images.

  - `required Boolean Authorized`

    Whether access is authorized for this study

  - `required IReadOnlyList<string> Urls`

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

  - `string Error`

    Error message if authorization failed or URLs cannot be provided

### Webhook Event

- `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).

  - `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.

    - `required string ID`

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

    - `required Data Data`

      Event payload containing study information

      - `required string StudyID`

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

      - `required 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')

    - `JsonElement Type "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.

    - `required string ID`

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

    - `required Data Data`

      Event payload containing report and study information

      - `required string PresignedUrl`

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

      - `required string ReportID`

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

      - `required string StudyID`

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

      - `string PlainText`

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

    - `JsonElement Type "report.delivered"constant`

      Event type identifier

### Unsafe Unwrap Webhook Event

- `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.

    - `required string ID`

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

    - `required Data Data`

      Event payload containing study information

      - `required string StudyID`

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

      - `required 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')

    - `JsonElement Type "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.

    - `required string ID`

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

    - `required Data Data`

      Event payload containing report and study information

      - `required string PresignedUrl`

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

      - `required string ReportID`

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

      - `required string StudyID`

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

      - `string PlainText`

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

    - `JsonElement Type "report.delivered"constant`

      Event type identifier

### Unwrap Webhook Event

- `class UnwrapWebhookEvent: 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.

    - `required string ID`

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

    - `required Data Data`

      Event payload containing study information

      - `required string StudyID`

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

      - `required 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')

    - `JsonElement Type "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.

    - `required string ID`

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

    - `required Data Data`

      Event payload containing report and study information

      - `required string PresignedUrl`

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

      - `required string ReportID`

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

      - `required string StudyID`

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

      - `string PlainText`

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

    - `JsonElement Type "report.delivered"constant`

      Event type identifier