Introduction

This guide is for AutoScribe only. If you are integrating Viewer without reporting, go to the Viewer integration. Clinical Platform does not require a separate integration; start from the Clinical Platform overview.

This is the integration path for IT, PACS, and RIS teams. You will create an API key, choose only the webhooks your workflow needs, implement those handlers, push studies from your system, and invite the people who will read and sign.

You can still create and manage studies in the AutoScribe dashboard. Use the API when you want that work to happen from your PACS, RIS, or EHR instead of by hand.

Work through the steps below in order. Skip a webhook endpoint if you do not need it — you almost never configure all six.

Integration steps

1. Create an API key — In the AutoScribe dashboard, generate a key with the right study scope and user permissions. Save the key when it is shown; you will not be able to view it again. Full walkthrough: API Config.

2. Decide which webhooks to configure — Endpoints depend on where DICOM is archived, whether images open in Avara Viewer, and whether Avara PACS is in the path. Start here, not by implementing every event: What webhooks should I configure.

3. Implement those webhooks — Verify signatures with unwrap(), then handle only the events you enabled. Examples are grouped by language: Node.js, TypeScript, Python, Java, C#.

4. Create studies from your system — Required if you are a PACS company (or platform) not using Avara PACS: this is how exams appear in AutoScribe. Customers on Avara PACS can skip it. Create studies.

5. Invite your users — Grant radiologists and staff access so they can open studies and sign reports. Inviting users.

How the viewer fetches pixels — presigned blob URLs, not DICOMweb — is on Loading Viewer Data.

For every operation the SDKs expose, see the API Reference.