Webhooks to get video status via API: Tutorial

 

Using web-hooks

Whenever a video is ready, our servers will send a POST request to the URL that you specify here. This provides a notification to your server so that you can take relevant actions e.g. publishing the video on your website or sending notifications to your viewers.

HTTP POST properties

The POST will be a json body and the content-type request header will beapplication/json. The JSON object will have the following properties. Note that new keys might be added in future without notice and you should not have a direct dependency to having an absolute structure when parsing this JSON.

        {
          "hookId": "______unique id of this hook______",
          "event": "video:ready",
          "time": 1538330269833,
          "payload": {
          "id": "___video id____",
          "title": "___ video title ___",
          "upload_time": 1538329973,
          "tags": null,
          "length": 160,
          "status": "ready"
        }
      

Authentication

It is a good idea to add a simple authentication parameter to the URL so that you can be sure that someone else is not sending a fake video-ready event. Here is an example of doing so.

http://example.com/video-is-ready.php?token=49eb0c0b29529216bab89627

With a URL like this, you can verify the token in your server application to verify that the POST request has indeed come from Vdocipher servers.

Text tutorial

These are the steps you need to follow-

1- Go to the “Config and Security” section.

2- Click on the “Web Hooks” option

3- Click on the “Create New Hook”

4- Enter the URL you want to add and click on “Create Web Hook” (Url must begin with HTTP or https)

5- And your Web Hook will be created.