Introduction

In the modern digital landscape, interconnectedness and data sharing are crucial requirements for online systems. To meet this need, VIDIZMO has introduced Webhooks, a powerful tool that allows users to subscribe to various events occurring within the VIDIZMO portal and receive notifications about them in their own business applications. With Webhooks, users can easily stay up-to-date on events such as video watched, video published, and workflow started, and use this information to trigger actions in their own systems.


Webhooks provide an easy and convenient way for users to integrate the VIDIZMO portal with their business applications, allowing for seamless communication between different systems. By subscribing to specific events, users can receive real-time notifications about changes in the VIDIZMO portal, enabling them to quickly respond to new developments and take necessary actions.



Overview

Using VIDIZMO webhooks is a simple and straightforward process that can be easily integrated into any web application. All you need to do is create a web application that can accept HTTP requests, and then add a new URL to your webhook application to start receiving notifications from VIDIZMO.


With VIDIZMO Webhooks, users have the flexibility to choose the specific events they want to be notified about, including video watched, video published, and workflow started, among others. Additionally, users can add custom headers to their post requests, providing greater control over the data being sent and received.



Roles & Permissions

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



How Webhooks Operate 

Webhooks are executed through an HTTP callback between two endpoints that communicate with each other. One endpoint sends a signal while the other acts as a listener. When a specific event is triggered in the VIDIZMO portal, the Notification service picks up the relevant information and sends it as event data to the configured endpoint in the form of an HTTP post request.


The key advantage of using Webhooks is that they work on an event-based output mechanism, unlike API calls which work on a request-based output mechanism. This means that instead of constantly polling for new information, Webhooks are triggered only when specific events occur, enabling real-time notifications and faster response times.


By leveraging Webhooks, users can easily subscribe to various events within the VIDIZMO portal and receive notifications about them in their own systems, providing a seamless and integrated experience. Overall, Webhooks provide a powerful and efficient means of integrating different systems and streamlining workflows, enabling businesses to be more responsive and efficient in their operations.



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

VIDIZMO provides its users with a dedicated log to monitor the status of their webhook notifications. This log keeps a record of all the webhook events that have been pushed, including successful attempts as well as failures. This log can be accessed from the Portal Settings of a Portal and provides detailed information about each event, including:


  1. Application ID: The unique identifier of the application that generated the webhook event.
  2. Date & Time: The date and time at which the event occurred.
  3. Events Occurred: The type of event that was triggered by the webhook.
  4. Configured Endpoint: The endpoint to which the webhook event was sent.
  5. Executed Retries: The number of times the webhook event was retried in case of a failure.
  6. Status of Notification: The status of the webhook notification, whether it was successful or failed.


Users can also filter these logs based on any of these parameters to quickly locate specific events. Additionally, users have the option to download these logs in either PDF or CSV format for offline analysis and reporting. These logs provide valuable insights into the status of webhook notifications, enabling users to quickly identify and resolve any issues.