Webhooks

Webhooks allow you to build or set up integrations which subscribe to certain events from your SHIFT72 platform.

Summary: Webhooks allow you to build or set up integrations which subscribe to certain events from your SHIFT72 platform.
Authentication: X-Shift-Signature
                      
                    

Introduction

Webhooks allow you to build or set up integrations which subscribe to certain events on your SHIFT72 platform. When one of those events is triggered, we’ll send a HTTP POST payload to the webhook’s configured URL. Webhooks can be used to be notified when an upload starts or is completed or be notified of certain ingestion events.

Currently, each webhook needs to be configured by SHIFT72. Once configured, they will be triggered each time one or more subscribed events occurs on your platform.

Events

When configuring a webhook, you can choose which events you would like to receive payloads for. Only subscribing to the specific events you plan on handling is useful for limiting the number of HTTP requests to your server. Contact your SHIFT72 account manager to change the list of subscribed events.

Each event corresponds to a certain set of actions that can happen on your platform. For example, if you subscribe to the upload event you’ll receive detailed payloads every time an upload is started or completed.

The available events are:

Name Description
upload_started Any time an upload starts.
upload_completed Any time an upload completes.
ingestion_updated Any time the ingestion status is updated.

Payload

Each event type has a specific payload format with the relevant event information. HTTP requests made to your webhook’s configured URL endpoint will contain a special header of X-Shift-Signature which is a HMAC hex digest of the payload, using the hook’s secret as the key. Contact your SHIFT72 account manager to find out the secret used for your webhooks.

Summary: Triggered when the ingestion status is updated.
Authentication: X-Shift-Signature
                      ingestion_updated
                    

Description

Triggered when the ingestion status is updated.

Response Parameters

Parameter Type Description
eventType string The event type. This will be set to ingestion_updated for this event.
notify string The internal url of the SHIFT72 API that was notified by the ingestion manager.
slug string The slug of the film or TV show and season.
publish bool The publish_after_ingestion flag set during the Upload Invite.
status string The overall status of the ingestion job. Can be one of: notstarted, started, encoding, packaging, completed, errored, cancelled.
updates array Array of the sub tasks within the ingestion job. See below for more details.

Response Parameters - Upload Array

Parameter Type Description
ingestion_uuid string The unique ID of the ingestion job.
package_output_id number The unique ID of the ingestion sub task.
drm_key_widevine string The drm key for Widevine DRM.
drm_key_playready string The drm key for PlayReady DRM.
drm_key_fairplay string The drm key for Fairplay DRM.
drms array of string DRM types. Can be one of: none, widevine, playready, widevine_classic.
content_encoding string Content encoding type. Can be one of trailer_mp4, sd_widevine_classic, sd_widevine_classic_download, dash_live_cenc, dash_cenc.
output_path string The relative path to where the content is stored.
status string The status of the ingestion sub task. Can be one of: queued, started, completed, errored.
width number The width of the media content.
height number The height of the media content.
bitrate number The bitrate of the media content.
error_message string The error message if the status is errored.
created_at string The ISO 8601 time and date the item was created.
updated_at string The ISO 8601 time and date the item was last updated.

Examples

Ingestion Completed Notification for a Trailer of Film 176

{  
   "notify":"https://store.shift72.com/services/content/v1/encoding",
   "publish":false,
   "slug":"/film/176",
   "status":"completed",
   "updates":[  
      {  
         "ingestion_uuid":"7e6aa985-c486-4b54-85a8-76c16514f44e",
         "package_output_id":9,
         "drm_key_widevine":null,
         "drm_key_playready":null,
         "drm_key_fairplay":null,
         "drms":[  
            "none"
         ],
         "content_encoding":"trailer_mp4",
         "output_path":"/7e6aa985-c486-4b54-85a8-76c16514f44e/marks_ingestion_test_1_trailer_kb.mp4",
         "status":"completed",
         "width":1024,
         "height":576,
         "bitrate":1603,
         "error_message":"",
         "created_at":"2016-04-07T23:09:19.914Z",
         "updated_at":"2016-04-07T23:28:35.071Z"
      }
   ],
   "eventType":"ingestion_updated"
}

Ingestion Completed Notification for Film 176

{
  "notify":"https://store.shift72.com/services/content/v1/encoding",
  "publish":false,
  "slug":"/film/176",
  "status":"completed",
  "updates":[  
     {  
        "ingestion_uuid":"c876eed9-dead-4869-8231-d94847a36b5b",
        "package_output_id":6,
        "drm_key_widevine":"36623281",
        "drm_key_playready":null,
        "drm_key_fairplay":null,
        "drms":[  
           "widevine_classic"
        ],
        "content_encoding":"sd_widevine_classic",
        "output_path":"/c876eed9-dead-4869-8231-d94847a36b5b/6/marks_ingestion_test_1.wvm",
        "status":"completed",
        "width":1024,
        "height":576,
        "bitrate":1996,
        "error_message":"",
        "created_at":"2016-04-07T20:49:52.491Z",
        "updated_at":"2016-04-07T22:57:02.771Z"
     },
     {  
        "ingestion_uuid":"c876eed9-dead-4869-8231-d94847a36b5b",
        "package_output_id":5,
        "drm_key_widevine":"36612585",
        "drm_key_playready":null,
        "drm_key_fairplay":null,
        "drms":[  
           "widevine_classic"
        ],
        "content_encoding":"sd_widevine_classic_download",
        "output_path":"/c876eed9-dead-4869-8231-d94847a36b5b/5/marks_ingestion_test_1.wvm",
        "status":"completed",
        "width":1024,
        "height":576,
        "bitrate":1996,
        "error_message":"",
        "created_at":"2016-04-07T20:49:52.489Z",
        "updated_at":"2016-04-07T22:57:02.923Z"
     },
     {  
        "ingestion_uuid":"c876eed9-dead-4869-8231-d94847a36b5b",
        "package_output_id":8,
        "drm_key_widevine":null,
        "drm_key_playready":"490db495-4957-4957-b96b-65a76c703a6c",
        "drm_key_fairplay":null,
        "drms":[  
           "playready"
        ],
        "content_encoding":"dash_live_cenc",
        "output_path":"/c876eed9-dead-4869-8231-d94847a36b5b/8/live/marks_ingestion_test_1.mpd",
        "status":"completed",
        "width":1024,
        "height":576,
        "bitrate":1996,
        "error_message":"",
        "created_at":"2016-04-07T20:49:52.495Z",
        "updated_at":"2016-04-07T22:57:03.055Z"
     },
     {  
        "ingestion_uuid":"c876eed9-dead-4869-8231-d94847a36b5b",
        "package_output_id":7,
        "drm_key_widevine":"c876eed9-dead-4869-8231-d94847a36b5b_HD",
        "drm_key_playready":null,
        "drm_key_fairplay":null,
        "drms":[  
           "widevine"
        ],
        "content_encoding":"dash_cenc",
        "output_path":"/c876eed9-dead-4869-8231-d94847a36b5b/7/marks_ingestion_test_1.mpd",
        "status":"completed",
        "width":1024,
        "height":576,
        "bitrate":1996,
        "error_message":"",
        "created_at":"2016-04-07T20:49:52.493Z",
        "updated_at":"2016-04-07T22:57:03.136Z"
     }
  ],
  "eventType":"ingestion_updated"
}
Summary: Triggered when an upload completes.
Authentication: X-Shift-Signature
                      upload_completed
                    

Description

Triggered when an upload completes.

Response Parameters

Parameter Type Description
eventType string The event type. This will be set to upload_completed for this event.
uploadToken string The upload token created when creating the Upload Invite.
slug string The slug of the film or TV show and season.
eventDatetime string The date and time, in ISO 8601 format, when the event was created.
status string The status of the Upload Invite.

Examples

Upload Completed Notification for Film 176

{  
   "eventType":"upload_completed",
   "uploadToken":"f6c179d841ef2c510687c739ae0ae93b",
   "slug":"/film/176",
   "eventDatetime":"2016-04-06T23:40:56.724+00:00",
   "status":"completed"
}
Summary: Triggered when an upload starts.
Authentication: X-Shift-Signature
                      upload_started
                    

Description

Triggered when an upload starts.

Response Parameters

Parameter Type Description
eventType string The event type. This will be set to upload_started for this event.
uploadToken string The upload token created when creating the Upload Invite.
slug string The slug of the film or TV show and season.
eventDatetime string The date and time, in ISO 8601 format, when the event was created.
status string The status of the Upload Invite.

Examples

Upload Started Notification for Film 176

{  
   "eventType":"upload_started",
   "uploadToken":"f6c179d841ef2c510687c739ae0ae93b",
   "slug":"/film/176",
   "eventDatetime":"2016-04-06T23:38:05.477+00:00",
   "status":"claimed"
}