Webhooks

Webhooks allow AdvaPACS to automatically send notifications to external systems when specific events occur. Instead of repeatedly polling the API for updates, your application can receive real-time event data whenever a configured event is triggered.

Common webhook use cases include:

• Notifying downstream systems when a study is created or updated.
• Triggering workflow automation after report completion.
• Synchronizing patient, order, or study data with third-party applications.

Supported Events

The available webhook events depend on your AdvaPACS configuration and enabled modules. Examples include:

Event	Description
study.created	A new study has been received or created.
study.updated	Study information has been modified.
study.completed	Study workflow has been completed.
report.created	A report has been created.
report.finalised	A report has been finalised and signed.
order.created	A new order has been received.
order.updated	An existing order has been updated.

Configuring a Webook

To configure a webhook:

1. Navigate to Configuration → Webhooks.
2. Select Add Webhook.
3. Enter the Endpoint URL.
4. Select the events you want to subscribe to.
5. Configure authentication if required.
6. Save the webhook configuration.

Once enabled, AdvaPACS will begin sending notifications whenever subscribed events occur.

Example Payload

All webhook events use the same payload structure. The eventType identifies the event that occurred, while the data object contains a reference to the affected resource. For example, when an order is created, AdvaPACS sends an ORDER_CREATED event:

{
  "timestamp": "2026-06-05T04:06:53.396337363Z",
  "eventId": "da80ed95-a33c-4526-940c-bbf277e13d50",
  "eventType": "ORDER_CREATED",
  "data": {
    "type": "order",
    "id": "94ede09f-3623-4d1b-9ea9-a288e44deb45"
  }
}

Retrieving Resource Data

Webhook payloads contain a reference to the affected resource rather than the full resource data.

After receiving a webhook, use the data.id value to retrieve the latest version of the resource from the AdvaPACS FHIR API.

For example, an ORDER_CREATED event may include:

{
  "eventType": "ORDER_CREATED",
  "data": {
    "type": "order",
    "id": "94ede09f-3623-4d1b-9ea9-a288e44deb45"
  }
}

You can then retrieve the related order using the FHIR ServiceRequest resource:

GET /fhir/R5/ServiceRequest/94ede09f-3623-4d1b-9ea9-a288e44deb45
Authorization: Bearer <access_token>
Accept: application/fhir+json