Zoom Webhooks
Introduction
Zoom Webhooks allow INSZoom to send automated messages or information to other client applications when an event occurs in the application. Typically, whenever there is change in state of data, a Webhook event is raised which consists of data in its current state. A Webhook provides client application with real time data. In case of API calls, the client application needs to continuously poll the data to get it in real time whereas Webhooks deliver this data in real time. Thus, Webhooks are essentially reverse API’s/HTTP Callbacks.
What does it offer?
Zoom Webhooks allow users to get information about changes to entities such as create/update/delete events for entities. INSZoom Webhooks can be used to get the data about entities in their current state from the INSZoom database without having to poll the database repeatedly. The data will be in JSON (JavaScript Object Notation) format. It offers the following benefits to INSZoom users-
- Zoom Webhooks help users to know if there is a change in state of data in INSZoom
- Zoom Webhooks helps users to keep their data in sync between INSZoom and other applications
- Zoom Webhooks are useful when there is interdependency between different events in a system
Getting Started with Zoom Webhooks
"Zoom Webhooks" is one of the subscription features offered by INSZoom that comes under the category of 'Integrations' features. Firm admins can subscribe to this service by clicking on the Subscribe button on Zoom Webhooks card in Setup > Subscriptions module.
How does it work?
There are set of pre-requirements or set of instructions that the Firm needs to follow to set up Zoom Webhooks. The set up instructions are given below-
- Open an end point/URL to Zoom Webhooks
Client application needs to open an end point/URL which accepts a post request from INSZoom. This URL will be provided to Zoom Webhooks which will send POST requests to the end point. This POST request will typically have data in JSON format. It’s advisable to open 3 end points which are configured to receive entities based on events (create, update, delete). - Process the POST request (Webhook request)
Once the client application receives a POST request it needs to process this request. The way these post requests are handled depends on the client. However, it’s important to know the behavior of Zoom Webhook requests before processing these requests.
Attributes of Zoom Webhooks Requests-
- Webhooks have timeout.
Webhooks are implemented with a timeout period and follow a retry policy. If the client application does not respond within the timeout period, retries will be attempted until a response is received.
- Webhook requests can be concurrent.
If multiple changes are done to the same entity repeatedly, it could result in concurrent post requests to the client application. The client application needs to manage such concurrencies.
- Webhook requests may change overtime.
The payload consists of data in JSON format. The order of fields in the payload or sometimes the fields itself may change overtime. The client application that processes the requests should be able to withstand such changes.
Zoom Webhooks Entity List
The entities and associated events currently supported by Zoom Webhooks are listed below-
