TABLE OF CONTENTS


Introduction

VIDIZMO is now enabling you to communicate with third party serversthrough using Webhooks. It’ll keep you well informed regarding all the events taking place in your portal. All you have to do is to just maintain a server able to accept the webhooks notification and a webhook app set up in your VIDIZMO’s portal. In this article we will discuss about the steps needs to be performed in order to set up your Webhook App. 

In order to understand VIDIZMO Webhooks better click here.



Roles and permissions

This feature is a part of all VIDIZMO product packages and Manager+ roles can create Webhook apps.



Steps


From the portal’s homepage:

  1. Click on Navigation Menu.
  2. Expand Admin tab and click on Portal Settings.




From Portal Settings:

  1. Click on Apps.
  2. Select Integration Apps.




From Integration Apps screen

  1. Click on Add New Apps
  2. Select Webhook.




From your newly created webhook app on Integration Apps Screen

  1. Click on Settings.



Now , From Webhook-Setting form:

Application

  1. Application Name: Enter any unique name of your choice for this specific Webhook Application.
  2. Application ID: A unique ID will be generated here for your app by default using which you can track the status of pushed notification from webhook logs.
  3. Endpoint: Enter the URL where all the event based data of subscribed events will be pushed.
  4. Active: Enable this toggle button if you want this app to be active and pick every triggered event that was subscribed and push them in the queue.


Authentication

  1. From the dropdown , Select No authentication If your configured endpoint doesn’t require any authentication and select Basic Authentication if it does requires authentication.


Events

  1. From the dropdown, Search and select your desired event or the entire category in order to subscribe them.


Advanced Settings

  1. Headers: Enter any additional information that you want to pass in the request headers. This isz an optional field.
  2. Retries: Enter the number of retries you want to be executed if any transient error takes place. By default 3 retries is configured and incase of any non transient error occurring the app will be disabled immediately.
  3. Retry Delay: Enter the time delay in seconds that you want in between the configured retries by default.


Test Connection

  1. Click on “Test Connection” to check your connection against your provided endpoint and authentication method. You can Save your app without testing connection.
  2. Click on Save Changes.




From Integration app screen

  1. Enable the toggle button present beside your newly created Webhook app.



Now, From Overflow Menu

  1. Click on Control Panel.


Webhook Logs

From Control Panel Screen

  1. Click on Security.
  2. Now Select Webhook Logs. You can check the status of pushed notifications of triggered event all other relevant parameters from these logs.



Understanding VIDIZMO Webhooks

VIDIZMO Webhooks Refrence Guide