CTMS APIs - Newsroom Management System Notifications

Newsroom Management notifications uses channels with the following pattern: avid.inews.notifications.<SystemID>.<ID>

Where:

SystemID

Name of the Newsroom Management system

ID

Folder or Queue ID

Notification types

To receive notifications client should subscribe to a queue or a folder.

queue.change

This type of notification is used to notify client about changes in the queue. Notification contains an object with the following properties:

Property Description

queueId

ID of the queue that triggered the notification

inserted

Indicates that new stories were inserted. The property is an array of JSON objects with the following sub properties:

  • storyId - ID of the new story

  • storyUuid - universally unique ID of new story

  • position - can be an ID of the upper story or "TOP" if the story was inserted into the top of the queue

  • positionUuid - can be either universally unique ID of the new story or "TOP" if the story was inserted into the top of the queue

ordered

Indicates that stories in the queue was reordered or grouped/ungrouped. Also it means that story was probably modified and client should request actual story attributes. The property is an array of JSON objects with the following sub properties:

  • storyId - ID of the story that was moved

  • storyUuid - universally unique ID of the story that was moved

  • position - can be an ID of the upper story or "TOP" if the story was moved into the top of the queue

  • positionUuid - can be either universally unique ID of the upper story or "TOP" if the story was moved into the top of the queue

modified

Indicates that stories were modified. The property is an array of JSON objects with the following sub properties:

  • storyId - ID of the story that was modified

  • storyUuid - universally unique ID of the story that was modified

deleted

Indicates that stories were deleted. The property is an array of JSON objects with the following sub properties:

  • storyId - ID of the story that was deleted

  • storyUuid - universally unique ID of the story that was deleted

sorted

Indicates that stories in the queue was sorted. Stories always sorting in ascending order, so there is no order property. The property is an object with the following sub properties:

  • field - Name of the field that stories was sorted by

folder.change

This type of notification is used to notify client about changes in the folder or queue depending on subscription accordingly. Notice, in case of folder subscription client will receive all notifications from all queues in this folder and subfolders. Notification contains an object with the following properties:

Property Description

folderId

ID of the item that triggered the notification

created

Indicates that new item was created. The property is a JSON object with following sub properties:

  • id - ID of the new item that was created

  • type - item type that can be one of these: "folder", "queue", "searchqueue"

deleted

Indicates that item was deleted. The property is a JSON objects with following sub properties:

  • id - ID of the item that was deleted

  • type - item type that can be one of these: "folder", "queue", "searchqueue"

Examples

Example: queue.change

{
    "channel": "avid.inews.notifications.YURII.SHOW",
    "subject": "queue.change",
    "data": {
        "queueId": "SHOW.TRAINING.RUNDOWN",
        "modified": [
            {
                "storyId": "SHOW.TRAINING.RUNDOWN..32175822.8560.1"
                "storyUuid": "38996f74-ee45-4f39-bfde-982b9c1151a8"
            }
        ]
    }
}

{
    "channel": "avid.inews.notifications.YURII.SHOW",
    "subject": "queue.change",
    "data": {
        "queueId": "SHOW.TRAINING.COMPOSITE",
        "inserted": [
            {
                "storyId": "SHOW.TRAINING.COMPOSITE..49029918.9714.0",
                "position": "TOP"
                "positionUuid": "TOP"
            }
        ],
        "deleted": [
            {
                "storyId":"SHOW.TRAINING.COMPOSITE..32252702.9714.0"
                "storyUuid": "c9028375-ccea-42df-8dea-4a92e5441510"
            }
        ]
    }
}

Example: folder.change

{
    "channel": "avid.inews.notifications.KIR.TEST",
    "subject": "folder.change",
    "data": {
        "folderId":"TEST.NEWQUEUE",
        "created": {
            "id": "TEST.NEWQUEUE.NEXT",
            "type": "queue"
        }
    }
}

{
    "channel": "avid.inews.notifications.KIR.TEST",
    "subject": "folder.change",
    "data": {
        "folderId": "TEST",
        "deleted": {
            "id": "TEST.OLDQUEUE",
            "type": "folder"
        }
    }
}