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 learn about the various changes which when made to the media triggers the mashupUpdate event - and how is it that you can get the relevant change information from the notification payload sent to your endpoint.
Below are a few changes that log an event for mashupUpdated:
- Tags updated in Media
- Custom Attributes updated in Media
- Media's Publish Settings changed
- Media's Access Settings changed
- Media Moderation Status changed
- Content within Media (such as Quiz, Survey, handouts, annotations, insights) are updated
Before you start
- For all the events mentioned above,
subjectDetails
contains complete mashupInfo Object with the exception of a few properties that may be irrelevant to the event under question. This guide shall help you determine the change-set of only relevant properties that changed during the event. To study the mashupInfo object and its properties in detail, see: API Reference Guide - MashupInfo Object.
Request Body Sample
Find below the event log object included in the request body of the notification payload sent whenever a media is updated.
{ "id": "66782" "vidizmoEventId": "MashupUpdated", "eventDate": "2020-10-26T15:04:53.593", "ip": "136.135.169.234", "status": "Success", "subjectType": "Video", "subjectId": 148912, "subjectTitle": "10 Reasons to Upgrade to Windows 10- MICROSOFT", "tenant": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object "subjectDetail": "{...}", //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110563-api-reference-guide-mashupinfo-object "user": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object "isSystem": false }
This object shall be sent for all changes made to the media (as identified above) with updated mashupInfo Object under subjedtDetails. Read further to understand what properties or objects within the mashupInfo Object shall help you determine the exact change that caused the mashupUpdated event to occur.
Tags Updated in Media
In order to view which tags have been updated in a media, you will need to check mashupInfo.tagInfo object in the complete object of mashupInfo.
Custom Attributes Updated in Media
In order to view which custom attributes and their values have been updated in a media, you will navigate to mashupInfo.mashupCustomAttributes object under the API Reference Guide - MashupInfo Object.
Publish Settings of Media Updated
In order to view the updated publish settings of media, you will navigate to mashupInfo.participation object under the API Reference Guide - MashupInfo Object.
Access Settings of Media Updated
In order to view the updated access settings of media, you will navigate to mashupInfo.defaultViewingAccess property under the API Reference Guide - MashupInfo Object.
Moderation Status of Media Updated
In order to view the updated moderation status of a media, you will navigate to mashupInfo.mashupModerations object under the API Reference Guide - MashupInfo Object.
Content within the Media Updated
In order to view what properties of content (renditions in case of videos/audios, questions and answers in case of Quizzes, etc) have been updated in a media, you will navigate to mashupInfo.contentInfo object in the complete object of mashupInfo.