Overview
VIDIZMO's Webhooks enable you to subscribe to the various events taking place within the VIDIZMO portal and receive notifications based on those events within your business application.
To read more about what Webhooks are and how to set them up, see: VIDIZMO Webhooks Reference Guide.
In this document, you will find a few samples of JSON Request Body of events that can be subscribed to in VIDIZMO.
Before you start
- In order to understand the various events associated with media being updated in the portal, see: Webhooks Payloads - Media Updated.
- In the request body samples below, mashupInfo Object sent in the event payload is the same for every event with the exception of a few properties that may be irrelevant to the event under question. This is why it has been excluded from the samples with an inclusion of only relevant properties that shall help you determine what changed. To study the object and its properties in detail, see: API Reference Guide - MashupInfo Object.
Media Viewed
Find below the event log object included in the request body of the notification payload sent when media is viewed.
Media Added to My Favorites
Find below the event log object included in the request body of the notification payload sent when media is favorited.
Media Removed from My Favorites
Find below the event log object included in the request body of the notification payload sent when media is unfavorited.
Media Clipped
Find below the event log object included in the request body of the notification payload sent when media is clipped. Here, complete mashupInfo object is included in subjectDetails, more details of which can be read from: API Reference - MashupInfo Object.
Media Liked
Find below the event log object included in the request body of the notification payload sent when media is liked.
Media Unliked
Find below the event log object included in the request body of the notification payload sent when media is unliked.
Media Shared via Mail
Find below the event log object included in the request body of the notification payload sent when media is shared via mail.
Feedback Provided on Media
Find below the event log object included in the request body of the notification payload sent when media is provided feedback on.
The sample payload remains the same for all other types of feedback with a change in vidizmoEventId that corresponds to the type of feedback being provided.
Access Rights Added
Find below the event log object included in the request body of the notification payload sent when media access license is assigned.
Access Rights Updated
Find below the event log object included in the request body of the notification payload sent when media access license is updated.
Access Rights Deleted
Find below the event log object included in the request body of the notification payload sent when media access license is deleted.
Media Deleted
Find below the event log object included in the request body of the notification payload sent when media is deleted.
Media Restored
Find below the event log object included in the request body of the notification payload sent when media is restored from Recycle Bin after deletion. Please note that after the retention policy configured in your Portal, deleted content shall no longer be restorable.
Media Copied
Find below the event log object included in the request body of the notification payload sent when media is copied.
Media Published
Find below the event log object included in the request body of the notification payload sent when media is published.
Media Downloaded
Find below the event log object included in the request body of the notification payload sent when media is downloaded.
Media Reuploaded
Find below the event log object included in the request body of the notification payload sent when media is reuploaded.
Default Publish Settings Changed
Find below the event log object included in the request body of the notification payload sent when media's default publish settings are changed.
Quiz/Survey Submitted
Find below the event log object included in the request body of the notification payload sent when a quiz or survey is submitted in portal.