Webex Rest API Adds Compliance Officer Webhooks

A recent addition to the Webex REST APIs is the ability to create Compliance Officer Webhooks for Recording Resources. Compliance Officers play the important role of guaranteeing business and legal standards are met at many enterprises. This blog will provide a brief overview of this new API feature and its significance.

A Web What?

A webhook is a form of Application Programming Interface (API) that is used primarily to enable applications to share data amongst themselves. They typically only share data in one direction and are activated by specific events which trigger some information to be sent back to a separate application. This allows developers to build intuitive apps that draw real-time information from multiple third-party websites.

Compliance Officer on Duty

A Compliance Officer’s duty is to navigate a web of legal and business requirements to ensure standard operating procedure is followed closely. For a company managing and publishing content recorded in Webex, these new webhooks will allow busy compliance officers to focus more attention on tasks at hand and automatically be notified any time a new recording is created within their organization.

Web Hooked Up

A Webhook for Compliance Officers to be notified of an organization’s Recordings is the first of its kind in Webex REST API. This mean’s a user with the spark_compliance:events_read scope assigned to them can set up a workflow that automatically fetches an organization’s recordings for any post-processing necessary. The API endpoint responsible for creating a new webhook requires we provide a URL that will be sent an HTTP POST request with a payload containing a new recording’s metadata along with information about the webhook itself. Here’s an example of a response from our API to the webhook’s URL when a recording is created :

{
  "id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL1dFQkhPT0svNTI0NDVhMGYtYWE3MS00NzRlLWJhOTMtOGJjOTIxMTlkODdm",
  "name": "Recording Created",
  "targetUrl": "https://webhook.site/181fd885-a88c-46bd-8cf4-fe0b097dbe0f",
  "resource": "recordings",
  "event": "created",
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi82MzgwNDY5Yy0zNWVlLTQ3OGYtYTRmOS0wYTFkMzZiNmNiOTc",
  "createdBy": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMjFmZmQ5MS0xZjZlLTQxJEDItYmQ1NC04ODNkYjlkMzEwNT",
  "appId": "Y2lzY29zcGFyazovL3VzSITHUExJQ0FUSU9OL0NmMzkyNWU5NDFmMzhhYTc0M2Y0MmFiNzcwZmZhZjFhNTIyMjcxZDI5OTQ4NDhjNjk2YWMwYTEwN2Q2YTg5MjI3",
  "ownedBy": "org",
  "status": "active",
  "created": "2022-08-05T01:19:23.311Z",
  "data": {
    "id": "346949fff8e6103ab9dd0050568105fb",
    "meetingId": "c9646f52613c4dbe8e2f7fb5cd554e6e_I_235103136776202975",
    "scheduledMeetingId": "c9646f52613c4dbe8e2f7fb5cd554e6e_20721231T090000Z",
    "meetingSeriesId": "c9646f52613c4dbe8e2f7fb5cd554e6e",
    "hostUserId": " Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMjFmZmQ5MS0xZjZlLTQxJEDItYmQ1NC04ODNkYjlkMzEwNT",
    "createTime": "2022-08-05T01:22:25.000+00:00",
    "format": "MP4",
    "durationSeconds": 30,
    "sizeBytes": 1384068,
    "siteUrl": "edsample-5xyn.webex.com",
    "orgId": "6380469c-35ee-478f-a4f9-0a1d36b6cb97"
  }
}
 

This new capability is unlocked using only one of the many spark_compliance scopes intended for use by Compliance Officers. For a full list of current spark_compliancescopes, please visit https://developer.webex.com/docs/compliance#compliance .

This is hardly the flashiest new feature to come out of Webex REST API, but a growing suite of solutions centered around compliance is a powerful tool that adds more versatility to what’s possible with Webex REST API.

Show Me

Here’s a brief video I made explaining and demonstrating usage of this new feature.

Stay Tuned!

The Webex Developer Evangelism team aims to keep our community informed on what’s possible with Webex from a developer’s point-of-view. We do that through blogs, videos, code samples, and webinars! New updates are always coming to the Webex eco-system; stay up to date by reading all of our latest blogs at developer.webex.com/blog and following us on Twitter @WebexDevs.

Your Feedback Matters

If you have feedback, suggestions, or you are encountering issues using Webex REST APIs, please reach out to our support team https://developer.webex.com/support, and we will be happy to help! In addition, feel free to post questions (and answers) in our Webex Developer Community.