TABLE OF CONTENTS

Introduction

In today’s highly interconnected world, the ability of independent online systems to communicate with other and share data is one of the core requirements. To cater this need, VIDIZMO has now introduced Webhooks which will 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. You can now conveniently use Webhooks to be notified on the events in VIDIZMO Portal (Video watched, Video published, Workflow started) using which you may want to trigger some action on within your own business application. 



Overview

In order to consume VIDIZMO webhooks you only need to create a web application that can accept the HTTP requests. If you already have a web application set up, using a webhook is easy as you just need to add a new URL to your Webhook application. VIDIZMO Webhooks let you choose your desired events , add custom headers with your post request and the ability to Test your connection on the given URL.



Roles & Permissions

This feature is a part of all VIDIZMO product packages and only Manager+ roles can create webhooks app. 



How Webhooks Operate 

Webhooks execution takes place between two endpoints which communicate with each other through HTTP callbacks. One endpoint sends signal whereas the other one acts as a listener.

Webhooks are triggered by specific events and whenever your configured event is triggered in VIDIZMO’s portal, Notification service picks the information relevant to the triggered event and push that event data to your configured endpoint in the form of an HTTP post request. 

The basic difference between an API call and webhooks is that API calls works on request-based output mechanisms whereas Webhooks works on event-based output mechanisms. 



VIDIZMO Webhook Application 

Multiple webhooks apps can be created configured on different endpoints and events. VIDZIMO provides you control over various aspects involving in the procedure of sending out these post calls. All the options and fields present in Webhooks App Settings are explained below: 


Application 

  1. Application Name: You can define any name for your Webhook Application. 
  2. Application Id: A unique system generated ID will be present here for your Webhook application. You can keep record of your
  3. Endpoint: It is the endpoint against which this application will be registered and the event data will be pushed on this endpoint. 
  4. Active: This toggle button activates your created app which means that the subscribed events will be picked after being triggered, They will be present in a queue and will pushed as soon as the app will be enabled from Integration App screen . 


Note: App will become inactive as soon any non transient error occurs.


Authentication Type :  You can choose the type of authentication that will be required on your configured endpoint. 


  • Single Factor Authentication : It is only one step of verifying identity for which you have to provide your Username and Password. 
  • No authentication : If no authentication is required to establish connection with your configured endpoint select this method. 


Events 

VIDIZMO’s events are present here to subscribe them. Events are placed in relevant categories, you can subscribe to a single event or the complete category. You can search for your desired event as well. You will get notification when your selected events will be triggered.



Advanced Settings


Headers 

You can add a custom http header to provide any additional information to the configured endpoint. users who want to add special authentication information, such as Good Dynamics tokens, to the headers of HTTP requests can add them using these customized headers. 


Retries 

You can configure the number of retries you want to be executed in case of failure because of any error. These retries will only occur for transient errors incase of any non transient error taking place the app will become inactive immediately. The retry is configured to 3 times by default. 


Retry Delay 

The time delay between the executed retries occurring incase of any transient error can be configured from here. The time delay is configured to 5 second by default. 



Test Connection

This button is present to test if a connection is established against your provided URL using your selected authentication method or not. Your Webhook app cannot be saved until the connection is established successfully. Hence, Testing connection is mandatory in order to create your Webhook app. Incase of connection getting failed try changing your authentication type and check the availability of your provided URL. 


Graphical user interface, application, Teams 
Description automatically generated
 



Webhook Logs

A separate log to keep record of your webhook pushed notifications are present so that you can always track its status. All the failures and successful attempts to push events data will be present here. Application ID , Date & Time, Events Occurred , Configured Endpoint , Executed Retries and Status of Notification are part of these logs. You can also filter these logs on the basis of these parameters. These logs can be downloaded in both PDF and CSV formats.


Graphical user interface, application 
Description automatically generated
 


Webhooks Payloads - Media Updated

Webhooks Payloads - Media Metadata

Webhooks Payloads - Media Actions

Webhook Payloads -Live Session

VIDIZMO Webhooks Reference Guide