What webhooks should I configure
Choose which AutoScribe webhook endpoints to set based on who you are, which Avara products you use, and where DICOM is archived.
Every AutoScribe integration is different. Which webhooks you configure depends on the customer’s workflow and which Avara products they use — especially whether DICOM archiving lives in your PACS or in Avara-managed PACS, and whether images are viewed in Avara Viewer.
Avara exposes six inbound webhook endpoints on an API key. All of them are optional. Leave an endpoint blank to disable it. You almost never need all six.
Use the matching profile below. Each profile names a typical company type or a platform that meets the same criteria.
PACS company without Avara Viewer
Section titled “PACS company without Avara Viewer”PACS company, or a platform that meets the following criteria:
- You are the DICOM archive of record (storage and retrieval live outside Avara)
- Radiologists view images in your viewer, not Avara Viewer
- AutoScribe is used for dictation and reporting, and finished reports must land back in your system
When archiving is outside Avara and you are not using Avara Viewer, Avara never needs to pull DICOM or write secondary captures to your storage. Configure Report Data. Clinical Context Enrichment is not required, but it is strongly recommended so the reader has a richer patient jacket during the interpretation.
| Dashboard label | Event type | Required? | Purpose |
|---|---|---|---|
| Report Data Webhook Endpoint | report.delivered | Required | Async notification when a signed report is delivered, so your PACS/RIS can store the report and update the study |
| Clinical Context Enrichment Webhook Endpoint | clinical_context.enrichment_requested | Strongly recommended | Soft pull of indication, technique, priors, and documents when a radiologist opens the study, so the reader has a richer patient jacket |
If you already generate a clinical-history summary yourself, pass it on study creation and leave this endpoint blank.
Leave Study Data, Secondary Capture, Modality Worklist, and Patient/Study Enrichment blank.
PACS company using Avara Viewer
Section titled “PACS company using Avara Viewer”PACS company, or a platform that meets the following criteria:
- You are the DICOM archive of record (storage and retrieval live outside Avara)
- Radiologists view images in Avara Viewer (standalone Viewer or the viewer inside AutoScribe)
- Finished reports must land back in your system
Avara does not hold the images. Before a study can be viewed, Avara asks you for presigned GET URLs. 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 Report Data and Study Data. Clinical Context Enrichment is not required, but it is strongly recommended so the reader has a richer patient jacket during the interpretation.
| Dashboard label | Event type | Required? | Purpose |
|---|---|---|---|
| Report Data Webhook Endpoint | report.delivered | Required | Async notification when a signed report is delivered |
| 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 |
| Clinical Context Enrichment Webhook Endpoint | clinical_context.enrichment_requested | Strongly recommended | Soft pull of indication, technique, priors, and documents when a radiologist opens the study, so the reader has a richer patient jacket |
If you already generate a clinical-history summary yourself, pass it on study creation and leave this endpoint blank.
Leave Modality Worklist and Patient/Study Enrichment blank unless you are also running Avara-managed PACS (see the next profile).
EHR/RIS with Avara-managed PACS
Section titled “EHR/RIS with Avara-managed PACS”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)
- You are the system of record for scheduling, orders, and demographics
- 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 can receive images and seed studies, but the RIS remains responsible for the study UID and for telling Avara what is scheduled. Configure these webhooks:
| Dashboard label | Event type | Required? | Purpose |
|---|---|---|---|
| Report Data Webhook Endpoint | report.delivered | Required | Completed reports appear in the EHR/RIS |
| 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 |
| Patient/Study Enrichment Webhook Endpoint | patient_study.enrichment_requested | Strongly recommended | Soft pull of demographics and study header fields when Avara PACS creates a study. Not a hard requirement — failures are treated as empty enrichment — but report headers will be incomplete without it |
| Clinical Context Enrichment Webhook Endpoint | clinical_context.enrichment_requested | Strongly recommended | Soft pull of indication, technique, priors, and supporting documents when a radiologist opens the study in AutoScribe. Not a hard requirement, but it is how the reader gets a synthesized patient jacket |
Leave Study Data and Secondary Capture blank unless this customer also views images through Avara Viewer against your object storage (the PACS-with-viewer profile). With Avara-managed PACS, image access is handled by Avara.
Clinical context — what to send
Section titled “Clinical context — what to send”Send Avara whatever you already have on the patient: indication and technique, prior reports, notes, and supporting documents. Avara summarizes that material and distills it into a highly relevant patient jacket — available to the reader and to AutoScribe’s AI tooling for the entire interpretation.
You can include any mix of:
- Clinical indication and technologist technique or notes
- Prior reports as free text (up to 10; include description, modality, and date when you have them)
- Inline free-text documents (up to 10)
- PDF or other clinical documents via presigned HTTPS download URLs (up to 10)
Avara retrieves those URLs, reads the files, and folds them into the same jacket. You do not need to pre-summarize anything unless you want to.
If you already produce a clinical-history summary yourself, pass it on study creation instead and skip this webhook.