Create a webhook

Learn how to create a webhook

JWP's webhooks allow you to automate your workflow by sending notifications to a designated URL endpoint when specific events occur, such as a new video is uploaded or a Broadcast Live stream is idle.



Create a webhook

Webhook creation page

Webhook creation page


Follow these steps to create a webhook:

  1. On the Webhooks page, click Create webhook. The new page appears.
  2. Under General, enter a Name for the webhook.
  3. (Optional) Enter a Description for the webhook.
  4. Enter the webhook URL.
  5. Under Properties, select one or several properties.
  6. Under Events, select one or several events.
  7. Click Save webhook. The new webhook will appear in the list of webhooks.


Events Reference

Conversions

Event Description
Conversions Complete Notification sent when both the thumbnail is ready and all initial video renditions have been processed

This event is only fired for the first media upload, and not when the media's original is replaced through a reupload.

Event Example
{
    "event": "conversions_complete",
    "media_id": "MNYaMSQl",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-27T00:20:57+00:00"
}

Live channel

Event Description
Live channel Is active Notification sent when a Live Channel enters an active state

Event Example
{
    "event": "channel_active",
    "channel_id": "YijbmYHJ",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-29T03:01:24+00:00"
}
Live channel Is idle Notification sent when a Live Channel enters an idle state

Event Example
{
    "event": "channel_idle",
    "channel_id": "t8JLGRl9",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-29T03:00:34+00:00"
}
Live channel Created Notification sent when a Live Channel is created

Event Example
{
    "event": "channel_created",
    "channel_id": "YijbmYHJ",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-29T02:59:57+00:00"
}

Media

Event Description
Media Available Notification sent when media is first publishable and indexed

At this point, the thumbnail is ready, but not all video renditions, such as those with higher resolutions, may have finished processing. If your media has a publish start date in the future, no Media Available notification will be sent.

Event Example
{
    "event": "media_available",
    "media_id": "MNYaMSQl",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-27T00:15:45+00:00"
}
Media Created Notification sent when media has been first uploaded

Event Example
{
    "event": "media_created",
    "media_id": "MNYaMSQl",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-27T00:13:10+00:00"
}
Media Deleted Notification sent when media has been deleted

Event Example
{
    "event": "media_deleted",
    "media_id": "MNYaMSQl",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-27T01:14:01+00:00"
}
Media Reuploaded Notification sent when a media has been reuploaded

The Media Reuploaded notification is the point at which the reupload has been initiated, not the time at which the reupload has been fully processed. You will receive Conversion Complete and Media Available notifications when conversions have been indexed and the media is first publishable.

Event Example
{
    "event": "media_reuploaded",
    "media_id": "MNYaMSQl",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-27T01:09:24+00:00"
}
Media Updated Notification sent when a media is updated

Event Example
{
    "event": "media_updated",
    "media_id": "MNYaMSQl",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-27T01:05:28+00:00"
}

Stream

Event Description
Stream Created Notification sent when the Broadcast Live stream has been successfully created

Event Example
{
    "event": "stream_created",
    "stream_id": "IfufXrxY",
    "webhook_id": "mvYr6Twx",
    "site_id": "HFWDaPJo",
    "event_time": "2024-09-17T14:41:47+00:00",
    "data": {
        "status": "requested"
    }
}
Stream Deleted Notification sent when the the Broadcast Live stream has been deleted

Event Example
{
    "event": "stream_deleted",
    "stream_id": "IfufXrxY",
    "webhook_id": "mvYr6Twx",
    "site_id": "HFWDaPJo",
    "event_time": "2024-09-17T14:57:47+00:00",
    "data": {
        "status": "deleted"
    }
}
Stream Go live Notification sent when the Broadcast Live stream has become available

Event Example
{
    "event": "stream_go_live",
    "stream_id": "IfufXrxY",
    "webhook_id": "mvYr6Twx",
    "site_id": "HFWDaPJo",
    "event_time": "2024-09-17T14:47:47+00:00",
    "data": {
        "status": "streaming"
    }
}
Stream Transitioned Notification sent when the Broadcast Live stream has transitioned to a new state

Event Example
{
    "event": "stream_transitioned",
    "stream_id": "IfufXrxY",
    "webhook_id": "mvYr6Twx",
    "site_id": "HFWDaPJo",
    "event_time": "2024-09-17T14:47:47+00:00",
    "data": {
        "status": "streaming"
    }
}
Stream Updated Notification sent when the properties of the Broadcast Live stream have changed

Event Example
{
    "event": "stream_updated",
    "stream_id": "IfufXrxY",
    "webhook_id": "mvYr6Twx",
    "site_id": "HFWDaPJo",
    "event_time": "2024-09-17T14:50:07+00:00",
    "data": {
        "status": "stopping",
        "ingest": {
            "rtmp": {},
            "srt": {
                "ingest_point": {
                    "url": "srt://ingest-9fbb8955abe1.jwplive.com:8000/"
                }
            },
            "srt_pull": {},
            "rtp": {},
            "hls_pull": {},
            "rtp_fec": {},
            "zixi_push": {}
        }
    }
}
{
    "event": "stream_updated",
    "stream_id": "IfufXrxY",
    "webhook_id": "mvYr6Twx",
    "site_id": "HFWDaPJo",
    "event_time": "2024-09-17T14:50:08+00:00",
    "data": {
        "status": "stopping",
        "playout": {
            "hls": "https://livecdn.use1-0004.jwplive.com/live/sites/HFWDaPJo/media/IfufXrxY/live.isml/.m3u8?t=2024-09-17T14:47:33-2024-09-17T14:49:02",
            "dash": "https://livecdn.use1-0004.jwplive.com/live/sites/HFWDaPJo/media/IfufXrxY/live.isml/.mpd?t=2024-09-17T14:47:33-2024-09-17T14:49:02"
        }
    }
}

Thumbnail

Event Description
Thumbnail Created Notification sent when a thumbnail is created

Event Example
{
    "event": "thumbnail_created",
    "thumbnail_id": "k9x00iro",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-27T00:13:25+00:00",
    "media_id": "MNYaMSQl"
}
Thumbnail Deleted Notification sent when a thumbnail is deleted

Event Example
{
    "event": "thumbnail_deleted",
    "thumbnail_id": "sl5swh3z",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-27T01:14:01+00:00",
    "media_id": "MNYaMSQl"
}

Track

Event Description
Track Created Notification sent when a track is created

Event Example
{
    "event": "track_created",
    "track_id": "VHsQNYq9",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-27T00:58:57+00:00",
    "media_id": "MNYaMSQl"
}
Track Deleted Notification sent when a track is deleted

Event Example
{
    "event": "track_deleted",
    "track_id": "VHsQNYq9",
    "webhook_id": "2yW4KmiG",
    "site_id": "9KboGBFu",
    "event_time": "2024-08-27T01:02:03+00:00",
    "media_id": "MNYaMSQl"
}



© 2007-2024 Longtail Ad Solutions, Inc.