Document toolboxDocument toolbox

Vidispine

Vidispine Notification [VF 21.4 IG]

Vidispine Notification can be subscribed via the Notification API. The details of the Vidispine Notification model can be found from the Vidispine documentation.

Path Swagger Reference: Creating a new Vidispine Notification

POST  /v1/Vidispine


In addition, the table describes the notification model required to register Vidispine Notification via VidiFlow Notification API.

Vidispine Notification Registration Model

{ "registrant": "string", "target": "string", "action": "string", "definition": "object" }

 

Field

Type

Description

Example

Registrant

String

A unique name represents the party that subscribe to this notification

YourSystemName

Target

String

The Vidispine Resource Type to subscribe to.

  • Item

  • Collection

Action

String

The Vidispine Resource Type + Trigger to subscribe to.

  • ItemCreate

  • ItemDelete

Definition

Object

This is the actual Vidisipine Notification model.