How does our Webhook work?

What do we need from you?

  1. The URL of your endpoint where we will send the notifications.

  2. The token or header with which you want us to authenticate (optional)

Send this information to [email protected]envelope so that your endpoint can be configured in our system.

What information will you receive?

There are different types of events within our platform that can be notified via the webhook. We currently have the following:

Event type
Description
Object sent

STUDY_CREATED

A study is created within the platform

Study

STUDY_SIGNED

A report is signed

Study

STUDY_ADDENDUM_SIGNED

An addendum is signed

Study

STUDY_PDF_FILE_UPDATED

A study PDF file was updated.

Study PDF

STUDY_PDF_FILE_CREATED

A study PDF file was created.

Study PDF

ORDER NEW

An order was created

Order

ORDER_PATIENT_ARRIVED

Notifies when the patient has arrived

Order

ORDER_IN_PROCESS

Notifies when the order changes to status

Order

ORDER_COMPLETED

Notifies when the order changes to status

Order

ORDER_CANCELLED

Notifies when the order changes to status

Order

STUDY_REPORT_BIRADS

Notifies when in a signed study the diagnosis is associated with a Birads value.

Study report

When any of these events is triggered, a request will be generated using the POST to the URL or URLs you indicate. This request will have the following structure

Objects sent

Each event sends the information of an object in the attribute data of the JSON. These are the different types of objects you can receive:

Study

How to sign a report in Eden?

Since this event is triggered when the report is signed, it is necessary to perform the following process from the platform.

Last updated