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.


This document aims to provide sample notification payloads for a few of the key events generated on a Live Broadcast session in VIDIZMO.


Live Session Published/Scheduled

Find below the event log object included in the request body of the notification payload sent whenever a Live Session is scheduled in VIDIZMO:


{
      "id": "66728",
      "vidizmoEventId": "MashupPublished",
      "eventDate": "2020-10-29T19:32:49.46",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Live",
      "subjectId": 152386,
      "subjectTitle": "Live Broadcast - CEO Speech",
      "tenant": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      "subjectDetail": "{\"Id\":152386,\"AddedBy\":{\"Id\":102000},\"Author\":{\"FirstName\":\"Esther\",\"LastName\":\"Fray\",\"Id\":0},\"Tenant\":{\"Id\":5975,\"TenantName\":\"LexCorp Incorporation\",\"SubDomainUrl\":\"yourportalURL.beta.vidizmo.com\",\"IsSSLEnable\":false,\"Weight\":0},\"Category\":{\"Id\":7073,\"Name\":\"General\",\"Weight\":0},\"EstimatedDuration\":1,\"Description\":\"Live Broadcast - CEO Speech\",\"Title\":\"Live Broadcast - CEO Speech\",\"Version\":1,\"Thumbnails\":[],\"CreatedDate\":\"2020-10-29T19:32:47.477\",\"CopyOfMashup\":{\"Id\":0,\"EstimatedDuration\":0,\"Weight\":0,\"Format\":\"All\",\"IsMyFlaggedMashup\":false},\"IsDeleted\":false,\"IsFeatured\":false,\"UpdatedDate\":\"2020-10-29T19:32:47.477\",\"UpdatedBy\":{\"Id\":0},\"Size\":0,\"ShowOnChannelLibrary\":false,\"ParentTenant\":{\"Id\":0,\"IsSSLEnable\":false,\"Weight\":0},\"DefaultViewingAccess\":\"Anonymous\",\"Status\":\"Published\",\"Weight\":0,\"Format\":\"Live\",\"IsExpired\":false,\"RecordingOfMashup\":{\"Id\":0,\"EstimatedDuration\":0,\"Weight\":0,\"Format\":\"All\",\"IsMyFlaggedMashup\":false},\"PublishingPointId\":1623,\"IsTranscriptionEnabled\":false,\"IsClipping\":false,\"IsRedaction\":false,\"IsFaceDetection\":false,\"MashupCustomAttributes\":[{\"Id\":366651,\"CustomAttributeId\":7526,\"CustomAttributeName\":\"Department\",\"CustomAttributeValue\":\"english 3\",\"CustomAttributeFieldTypeId\":\"DropDown\",\"Displayable\":true,\"Searchable\":true,\"Facetable\":false}],\"LiveStartDateTime\":\"2020-10-30T00:31:00\",\"LiveStatus\":\"Upcoming\",\"LiveTimeZoneOffSet\":5.0,\"LiveDaylightSaving\":false,\"Content\":[{\"Id\":603936,\"FileName\":\"General Streaming Server PP\",\"TenantId\":5975,\"ContentStorageId\":0,\"ContentFormatId\":21,\"ContentType\":\"Video\",\"ContentStatus\":\"Purged\",\"IsImport\":true,\"IsDeleted\":false,\"Size\":0,\"IsLive\":true,\"PublishingPointId\":1623,\"ContentDetails\":{\"ContentFiles\":[{\"FileSize\":0,\"ContentFileAttributes\":[{\"Name\":\"MimeType\",\"Value\":\"application/octet-stream\"}],\"StreamType\":\"HLS\",\"PlaybackURL\":\"https://iframe.dacast.com/b/134648/c/504760\"},{\"FileSize\":0,\"ContentFileAttributes\":[{\"Name\":\"MimeType\",\"Value\":\"application/octet-stream\"}],\"StreamType\":\"HDS\",\"PlaybackURL\":\"https://iframe.dacast.com/b/134648/c/504760\"},{\"FileSize\":0,\"ContentFileAttributes\":[{\"Name\":\"MimeType\",\"Value\":\"application/octet-stream\"}],\"StreamType\":\"RTMP\",\"PlaybackURL\":\"https://iframe.dacast.com/b/134648/c/504760\"}]}}],\"LiveMashupDetail\":{\"RemainingTimeForlive\":-109.4288402,\"ShowSchedule\":true,\"ShowTwitterFeed\":false,\"ShowFAQ\":true,\"FAQ\":\"Frequently Asked Questions!\",\"ShowYammerFeed\":false,\"YammerFeedType\":\"None\",\"IsChatArchiveEnabled\":false},\"Player\":{\"PlayerTemplateDetail\":{\"PlayerTemplateId\":296,\"PlaybackBehaviour\":{\"PreserveUserSettings\":true,\"AutoPlay\":true,\"AutoAdvance\":false,\"Loop\":false,\"LowbandwidthInitialize\":false,\"Muted\":false},\"ActionControl\":{\"Zoom\":false,\"Scrubbing\":false,\"SeekByFrame\":false,\"TheaterMode\":true,\"QualitySelector\":true,\"ClosedCaptions\":false,\"Sharing\":true,\"PlaybackRate\":{\"Display\":false,\"Rates\":[\"0.5\",\"1\",\"1.5\",\"2\"]},\"Bookmark\":true,\"FullScreenMode\":true,\"Comment\":false,\"Chapters\":false,\"Annotation\":false,\"ShortCutKeys\":true},\"MashupFormat\":\"Live\"},\"DisplayTimedData\":false,\"CompletionCriteria\":[{\"Property\":\"Marker\",\"Criteria\":\"Equal To\",\"CriteriaValue\":\"100\"}],\"IsVideo360\":false},\"Participation\":{\"CommentEnabled\":false,\"CommentModerationRequired\":false,\"IsMashupStatsEnabled\":false,\"IsDownload\":false,\"IsEmbed\":false,\"IsSocialSharing\":true},\"MashupModerations\":[],\"IsMyFlaggedMashup\":false}",
      "user": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }


Live Session Started

Find below the event log object included in the request body of the notification payload sent whenever a Live Session is started in VIDIZMO:


{
      "id": "66728",
      "vidizmoEventId": "MeetingStarted",
      "eventDate": "2020-10-29T19:33:02.663",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Chat",
      "subjectId": 0,
      "subjectTitle": "Chat",
      "tenant": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      "user": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }


Live Session Paused/Resumed

Find below the event log object included in the request body of the notification payload sent whenever a Live Session is paused or resumed in VIDIZMO:


{
      "id": "66728",
      "vidizmoEventId": "LiveMashupStatusChanged",
      "eventDate": "2020-10-29T19:33:57.43",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Live",
      "subjectId": 152386,
      "subjectTitle": "Live Broadcast - CEO Speech",
      "tenant": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      "description": "Running",
      "subjectDetail": "152386",
      "previousSubjectDetail": "152386",
      "user": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }


Meeting Joined

Find below the event log object included in the request body of the notification payload sent whenever a Live Session is joined by a user in VIDIZMO:


{
      "id": "66728",
      "vidizmoEventId": "MeetingJoined",
      "eventDate": "2020-10-29T19:33:02.727",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Chat",
      "subjectId": 0,
      "subjectTitle": "Chat",
      "tenant": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      "user": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }


Meeting Left

Find below the event log object included in the request body of the notification payload sent whenever a user discontinues watching a Live Session in VIDIZMO:


{
      "id": "66728",
      "vidizmoEventId": "MeetingLeft",
      "eventDate": "2020-10-29T19:23:04.05",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Chat",
      "subjectId": 0,
      "subjectTitle": "Chat",
      "tenant": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      "user": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }


Live Session Ended

Find below the event log object included in the request body of the notification payload sent whenever a Live Session is ended in VIDIZMO:


{
      "id": "66728",
      "vidizmoEventId": "LiveMashupCompleted",
      "eventDate": "2020-10-29T19:34:06.37",
      "ip": "136.135.169.234",
      "status": "Success",
      "subjectType": "Live",
      "subjectId": 152386,
      "subjectTitle": "Live Broadcast - CEO Speech",
      "tenant": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110689-api-reference-guide-tenantinfo-object
      "description": "Completed",
      "subjectDetail": "{\"MashupId\":152386}",
      "user": {...},//Read more about the object here: https://help.vidizmo.com/en/support/solutions/articles/17000110691-api-reference-guide-userprofileinfo-object
      "isSystem": false
    }