What webhooks should I configure
Choose which Viewer webhook endpoints to set based on whether you archive DICOM yourself or use Avara PACS.
Viewer only implements three inbound webhooks. You almost never need every Viewer endpoint; pick from the two profiles below. Report delivery, patient/study enrichment, and clinical context enrichment are AutoScribe, not Viewer.
Which of the three you set depends on whether DICOM archiving lives in your PACS or in Avara-managed PACS. Leave unused endpoints blank.
Use the matching profile below. Each profile names a typical company type or a platform that meets the same criteria.
PACS company using Avara Viewer
Section titled “PACS company using Avara Viewer”PACS company using Avara Viewer, or a platform with their own DICOM archive that meets the following criteria:
- You are the DICOM archive of record (storage and retrieval live outside Avara)
- You are integrating Avara Viewer — images always open in Avara Viewer
- Avara does not hold the pixels
Avara asks you for presigned GET URLs before a study can be viewed. Secondary Capture is recommended if you want readers to save a new series as a secondary capture back to your storage — annotations save out of the box without this webhook.
Configure Study Data. Secondary Capture is recommended.
| Dashboard label | Event type | Required? | Purpose |
|---|---|---|---|
| Study Data Webhook Endpoint | study.access_requested | Required | Presigned GET URLs so the viewer can load DICOM (and optional non-DICOM media) |
| Secondary Capture Webhook Endpoint | secondary_capture.access_requested | Recommended | Lets readers save a new series as a secondary capture back to your storage. Annotations save out of the box without this webhook |
Leave Modality Worklist blank.
EHR/RIS with Avara PACS and Avara Viewer
Section titled “EHR/RIS with Avara PACS and Avara Viewer”EHR or RIS company, or a platform that meets the following criteria:
- Avara PACS is the archive (on-prem PACS nodes receive C-STORE from modalities)
- Images are viewed in Avara Viewer
- You are the system of record for scheduling and orders
- You own the Study Instance UID lifecycle — your RIS allocates and maintains study UIDs; Avara does not invent them for you
- Modalities request worklists through Avara PACS (C-FIND MWL)
Avara PACS already has the images, so Viewer does not call your storage for GET or PUT. Configure one webhook:
| Dashboard label | Event type | Required? | Purpose |
|---|---|---|---|
| Modality Worklist Webhook Endpoint | modality_worklist.requested | Required | Called when a modality requests a worklist. Avara PACS relays your scheduled exams to the machine so scanning workflows stay aligned. Only one active API key per organization may have this set |
Leave Study Data and Secondary Capture blank. Image access is handled by Avara PACS.