TABLE OF CONTENTS


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 JSON Request Body of events related to change in Media's metadata that can be subscribed to in VIDIZMO.


Before you start

  • For sample payloads that include commentInfo objects as subjectDetails, we have included only the properties that are relevant for the event in question. To study entire Comments object and its properties, see: Reference API - Comments Object.


Comments Added

In the request JSON below, you will be able to see that whenever a comment is added on a media in a Portal, then entire Comment object is included in the body under subjectDetails. 


{
      "id": "66278",
      "vidizmoEventId": "CommentAdd",
      "eventDate": "2020-10-26T06:29:52.657",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Video",
      "subjectId": 263482,
      "subjectTitle": "Annual Conference Summit 2019",
      "tenant": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      // Complete Comment object will be included whenever a user adds a new Comment on a media.
      //Read more about it from: https://help.vidizmo.com/en/support/solutions/articles/17000110690-api-reference-guide-commentinfo-object
      "subjectDetail": "{...}", //
      "user": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }


Comments Updated

In the request JSON below, you will be able to see the current object under subjectDetail. The moderator updated the comment from "This video's been the most interesting lesson I have learned!" to "This video's been the most interesting lesson I have learned." while there are no other changes made to the comment object.


{
      "id": "66728",
      "vidizmoEventId": "CommentUpdate",
      "eventDate": "2020-10-26T06:30:15.657",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Video",
      "subjectId": 263482,
      "subjectTitle": "Annual Conference Summit 2019",
      "tenant": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
       //this shall contain the updated CommentInfo object but only relevant property has been shown here
      //Read more about it from: https://help.vidizmo.com/en/support/solutions/articles/17000110690-api-reference-guide-commentinfo-object
      "subjectDetail": "{...\"CommentContent\":\"This video's been the most interesting lesson I have learned.\"...}",
      "user": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }


Comments Deleted

In the request JSON below, you will be able to see that whenever a comment is deleted on a media in a Portal, then entire commentInfo object is included in the body under subjectDetails.


{
      "id": "66278",
      "vidizmoEventId": "CommentDelete",
      "eventDate": "2020-10-26T06:19:20.203",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Video",
      "subjectId": 263482,
      "subjectTitle": "Annual Conference Summit 2019",
      "tenant": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      //Complete CommentInfo object willl be included whenever a user deletes a Comment on a media
      //Read more about it from: https://help.vidizmo.com/en/support/solutions/articles/17000110690-api-reference-guide-commentinfo-object
      "subjectDetail": "{...}",
      "user": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }


Custom Attributes Added in Portal

In the request JSON below, you will see details about the Custom Attributes and its values added in the Portal.


{
      "id": "66728",
      "vidizmoEventId": "CustomAttributesAdded",
      "eventDate": "2020-10-26T05:28:58.733",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "CustomAttribute",
      "subjectId": 71221,
      "tenant": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      "description": "Custom Attributes Added",
      "subjectDetail": "{\"Id\":71221,\"FieldName\":\"Type\",\"FieldTypeId\":\"DropDown\",\"FieldValues\":\"Seekable Content, Non-seekable Content, Forms\",\"MashupFormats\":[\"Audio\",\"Collection\",\"Document\",\"Image\",\"Playlist\",\"Video\",\"Quiz\",\"Survey\",\"Live\"],\"TenantId\":18761,\"IsMandatory\":true,\"Order\":1,\"Displayable\":true,\"Searchable\":true,\"Facetable\":true,\"MashupCount\":0}",
      "user": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }


Custom Attributes Updated in Portal

In the request JSON below, you will see details about the Custom Attributes and its values updated in the Portal.


{
      "id": "66728",
      "vidizmoEventId": "CustomAttributesUpdated",
       "eventDate": "2020-10-26T17:20:40.147",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "CustomAttribute",
      "subjectId": 280,
      "tenant": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      "description": "Custom Attributes Update",
      "subjectDetail": "{\"Id\":280,\"FieldName\":\"Evaluation\",\"FieldTypeId\":\"DropDown\",\"FieldValues\":\"Positive / Correct,Negative / Incorrect\",\"MashupFormats\":[\"Video\"],\"TenantId\":2,\"IsMandatory\":false,\"Order\":30,\"Displayable\":false,\"Searchable\":true,\"Facetable\":false,\"MashupCount\":1}",
      "user": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }



Custom Attributes Deleted from Portal

In the request JSON below, you will see details about the Custom Attributes and its values deleted in the Portal.


{
      "id": "66728",
      "vidizmoEventId": "CustomAttributesDeleted"
      "eventDate": "2020-10-26T09:57:30.327",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "CustomAttribute",
      "subjectId": 0,
      "subjectTitle": "AA2",
      "tenant": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object,
      "description": "Custom Attributes Deleted",
      "user": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }


Category Added in Portal

In the request JSON below, you will see details about the Category added in the Portal.


{
      "id": "66728",
      "vidizmoEventId": "CategoryAdded",
      "eventDate": "2020-10-26T06:21:33.753",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Category",
      "subjectId": 25828,
      "tenant": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object,
      "subjectDetail": "{\"Id\":25828,\"TenantId\":18761,\"ParentCategoryId\":0,\"Name\":\"Sales\",\"AddedBy\":218003,\"UpdatedBy\":218003,\"CategoryDetail\":{},\"Weight\":0}",
      "user": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }


Category Updated in Portal

In the request JSON below, you will see details about the Category updated in the Portal.


{
      "id": "66728",
      "vidizmoEventId": "CategoryUpdated",
      "eventDate": "2020-10-26T13:02:08.733",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Category",
      "subjectId": 1,
      "subjectTitle": "International World Cup Qatar 2022 - 1000 DAYS TO GO!",
      "tenant": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      "description": "",
      "subjectDetail": "{\"Id\":1,\"TenantId\":2,\"ParentCategoryId\":0,\"Name\":\"TOPICS (2020)\",\"Description\":\"Fouls, Offside, Penalty\",\"AddedBy\":4,\"UpdatedBy\":4,\"AddedDate\":\"2014-02-24T16:59:39.72\",\"UpdatedDate\":\"2020-10-24T01:08:14.277\",\"IsDeleted\":false,\"IsDefault\":true,\"CategoryDetail\":{\"ThumbnailImageUrl\":\"https://yourportalURL.com/b218de14-34fc-4e85-8c4b-3dbb4dfc7723/5d7d8f908150cad7a1845d35e73c5c54.jpg\"},\"IsFeatured\":true,\"Weight\":3,\"IsDrafted\":false,\"ChildCategories\":[]}",
      "previousSubjectDetail": "{\"Id\":1,\"TenantId\":2,\"ParentCategoryId\":0,\"Name\":\"TOPICS (2025)\",\"Description\":\"Challenges, Penalty\",\"AddedBy\":2,\"UpdatedBy\":2,\"AddedDate\":\"2014-02-24T16:59:39.72\",\"UpdatedDate\":\"2020-10-23T23:18:29.04\",\"IsDeleted\":false,\"IsDefault\":true,\"CategoryDetail\":{\"ThumbnailImageUrl\":\"https://yourportalURL.com/b218de14-34fc-4e85-8c4b-3dbb4dfc7723/5d7d8f908150cad7a1845d35e73c5c54.jpg\"},\"IsFeatured\":true,\"Weight\":3,\"IsDrafted\":false,\"ChildCategories\":[]}",
      "user": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
       "isSystem": false
}


Category Deleted from Portal

In the request JSON below, you will see details about the Category deleted in the Portal.


{
      "id": "66728",
      "vidizmoEventId": "CategoryDeleted",
      "eventDate": "2020-08-04T15:36:26.443",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Category",
      "subjectId": 20,
      "subjectTitle": "Product Engineering",
      "tenant": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      "description": "DeleteCategory",
      "subjectDetail": "\"\"",
      "user": {...}, //Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }