¶ Integrating with Third-party Applications via Webhooks
Revision date: 11/nov/2022
Vizzi version: 1.12.0
Through webhooks, Vizzi becomes highly integrable with third-party applications, providing instant, real-time communication whenever a specific action is performed.
¶ How Webhooks Work
Webhook is a mechanism used for data exchange between two applications as soon as a specific event happens.
An example of using webhooks in Vizzi is the possibility of communication with a Customer Relationship Management (CRM) system every time a customer is created, updated, or deleted.
Another example that can increase engagement to your platform is notifying customers every time a new VOD or Live is added. In this case, after content is added, the necessary data is sent to a notification system which in turn will notify your customers that new content of interest to them is available.
All this communication between Vizzi, the notification system, and the client is made through webhooks that are activated as soon as new content is added.
These events, in Vizzi, can be parameterized for any entity, whether VOD, live, EPG, actionable, category, collection, product, campaign, audience, customer, admin, frontend configuration, or virtual screen.
For each entity, you can configure as many webhooks as needed. These webhooks can be triggered on create, read, update, or delete operations.
And for each operation, you can parameterize as many methods as you want. These methods can be Post, Get, Put, Delete, or Patch.
¶ How to Perform This
First, access the Web Hooks tab in the Settings menu, click on the “ADD” button, and fill in all the fields as described below:
- Entity name: click to select the entity that will trigger the request. The entity can be any of the Vizzi modules;
- Operation type: click to select the type of operation. By configuring this, you are defining that the webhook will be triggered whenever the entity chosen in the “Entity name” field is created, read, updated, or deleted;
- URL: enter the webhook endpoint URL to be called. To send information to another system, it is necessary to indicate where this information will be sent. This location is indicated via a URL.;
- Request method: click to select the request method from the list. They can be “Post”, “Get”, “Put”, “Delete”, or “Patch”;
- Send payload data: if enabled, the payload data will be sent along with the webhook request. E.g. When creating a Customer, the customer object will be sent as the payload of the webhook request.
As you can see in the image below, it is possible to create multiple webhooks for the same entity:
With Vizzi, the communication between your systems can be quick and simple to implement. Take advantage of this facility to add more functionality to your video platform.
For more details on setting up Vizzi, please refer to the Settings page of the online user manual.