VIEW webhooks

If the WebhookUrl configuration of NgvConfiguration is filled, then VIEW can notify a third-party system about events that happen in the system through a webhook mechanism, using an HTTP POST request. Currently, VIEW can send events only to a single registered endpoint.

Digital Pathology webhooks

VIEW identifies each event type through eventType attribute. Even though each event is specific to its trigger, the whole slide status will be sent each time (e.g. favourite slide event message includes information about slide flip and tags).

Favorite slide event

A favorite slide event is triggered by marking or unmarking a slide as a favourite.

JSON

{
    "eventType": "toggle_favourite_slide",
    "timestamp": "2024-02-06T16:46:01.168871",
    "username": "Administrator",
    "data":
    {
        "studyInstanceUID": "1.2.826.0.1.3680043.2.619.161.1649522669",
        "seriesInstanceUID": "1.2.826.0.1.3680043.2.619.6703.1690970136721.1",
        "accessionNumber": "I23-08021155",
        "containerIdentifier": "I23-08021155-A-1-1",
        "reviewStatus": "COMPLETED",
        "flipped": true,
        "favourite": false,
        "tags":[
          "Cancer",
          "DCIS"
        ]
    }
}

Slide flip event

A slide flip event is sent every time a digital slide is viewed for the first time. The event is triggered only if the user performs at least one pan or zoom operation on the slide.

This event was marked as deprecated in VIEW version 4.45.4 and will be completely removed in a further release along the flipped property in every event body. It will be substitued with the new Slide review status event.

JSON

{
    "eventType": "slide_flip",
    "timestamp": "2024-02-06T16:46:01.168871",
    "username": "Administrator",
    "data":
    {
        "studyInstanceUID": "1.2.826.0.1.3680043.2.619.161.1649522669",
        "seriesInstanceUID": "1.2.826.0.1.3680043.2.619.6703.1690970136721.1",
        "accessionNumber": "I23-08021155",
        "containerIdentifier": "I23-08021155-A-1-1",
        "reviewStatus": "COMPLETED",
        "flipped": true,
        "favourite": false,
        "tags":[
          "Cancer",
          "DCIS"
        ]
    }
}

Slide review status

A slide review status will be sent when:

the user performs any action (e.g.: pan, zoom) on a slide for the first time;
the user manually marks the slide as completed or started using the dedicated button;

The reviewStatus property will contain the current slide review status: it can be valued to NONE if the slide was never interacted with, STARTED if the user has performed any action on a slide and COMPLETED if the user manually marked it using the dedicated button.

This event was introduced to replace the Slide flip event in VIEW version 4.45.4. The previous event was marked as deprecated and will be removed in a further release along with the flipped property.

JSON

{
    "eventType": "review_status",
    "timestamp": "2024-02-06T16:46:01.168871",
    "username": "Administrator",
    "data":
    {
        "studyInstanceUID": "1.2.826.0.1.3680043.2.619.161.1649522669",
        "seriesInstanceUID": "1.2.826.0.1.3680043.2.619.6703.1690970136721.1",
        "accessionNumber": "I23-08021155",
        "containerIdentifier": "I23-08021155-A-1-1",
        "reviewStatus": "COMPLETED",
        "flipped": true,
        "favourite": false,
        "tags":[
          "Cancer",
          "DCIS"
        ]
    }
}

Tag event

A tag event is triggered every time a user adds or removes a tag from an image. If no tag is present, then an empty tag array must be expected.

JSON

{
    "eventType": "tagged_image",
    "timestamp": "2024-02-20T12:25:38.7765729",
    "username": "Administrator",
    "data":
    {
        "studyInstanceUID": "1.2.826.0.1.3680043.2.619.161.1080391579",
        "seriesInstanceUID": "1.2.826.0.1.3680043.2.619.5234.1676901039187.1",
        "accessionNumber": "I19-00102",
        "containerIdentifier": "I19-00102-A-1-2",
        "reviewStatus": "COMPLETED",
        "flipped": true,
        "favourite": false,
        "tags":
        [
            "Cancer",
            "DCIS"
        ]
    }
}