Boomstream is a professional video platform for business: host video on your site, run live streams, protect content with DRM and watermarks, sell access and integrate through our API. Infrastructure in Russia, 30-day trial.

Webhook events and data

webhooks

Boomstream Webhook Events: Complete API Reference

This document provides a complete reference of all available webhook events on the Boomstream platform. Webhook notifications enable real-time automation, allowing you to seamlessly integrate Boomstream with external systems (CRM, CMS, analytics), track purchases, and monitor video processing status.

media.created

Triggered when a new media file is initially created in the system.

JSON 
{
  "date": "2022-06-07T09:21:20.886Z",
  "webhook": "media.created",
  "media": {
    "code": "xxxxxxxx",
    "title": "example conf - date"
  },
  "source": {
    "code": "f30d52f4-2f18-4a63-b823-899a1c1097b0",
    "title": "example - 2024-03-11 16:17:51",
    "type": "conference"
  }
}

media.completed

Triggered when media processing (transcodes, screenshots, etc.) is successfully completed.

JSON 
{
  "date": "2022-06-07T09:21:20.886Z",
  "webhook": "media.completed",
  "media": {
    "code": "xxxxxxxx",
    "title": "example conf - date"
  },
  "source": {
    "code": "f30d52f4-2f18-4a63-b823-899a1c1097b0",
    "title": "example conf",
    "type": "conference"
  }
}

media.failed

Triggered when media processing fails or encounters an error.

JSON 
{
  "date": "2022-06-09T07:10:25.590Z",
  "webhook": "media.failed",
  "media": {
    "code": "xxxxxxxx",
    "title": "example"
  }
}

ppv.bought

Triggered when a user successfully purchases paid access (PPV) to the content.

JSON 
{
  "date": "2022-06-09T06:57:05.000Z",
  "webhook": "ppv.bought",
  "email": "test@test.com",
  "gateway": {
    "title": "Bank Card"
  },
  "subscription": {
    "code": "xxxxxxxx",
    "title": "Password access"
  },
  "media": {
    "type": "media",
    "code": "xxxxxxxx",
    "title": "example"
  }
}

live.started

Triggered when a live broadcast begins streaming.

JSON 
{
  "date": "2022-06-07T13:41:02.431Z",
  "custom_field": "",
  "webhook": "live.started",
  "media": {
    "code": "xxxxxxxx",
    "title": "example"
  }
}

live.stopped

Triggered when a live broadcast ends or is stopped.

JSON 
{
  "date": "2022-06-07T09:06:47.757Z",
  "custom_field": "",
  "webhook": "live.stopped",
  "media": {
    "code": "xxxxxxxx",
    "title": "example"
  }
}

screenshots.completed

Triggered after screenshot generation for a media file is fully completed.

JSON 
{
  "date": "2022-06-07T09:21:04.039Z",
  "code": "xxxxxxxx",
  "webhook": "screenshots.completed",
  "screenshots": [
    {
      "code": "4rNofpLd-a1",
      "width": "1600",
      "isPoster": "yes",
      "url": "https://bs.boomstream.com/balancer/4rNofpLd-a1.jpg",
      "height": "900"
    },
    {
      "code": "4rNofpLd-a2",
      "width": "1600",
      "isPoster": "no",
      "url": "https://bs.boomstream.com/balancer/4rNofpLd-a2.jpg",
      "height": "900"
    }
  ]
}
Field Description
code Unique screenshot identifier code
width Image width in pixels
height Image height in pixels
isPoster Indicates if the image is set as the poster (yes/no)
url Direct CDN link to the screenshot image

password.activate

Triggered when a user successfully activates password-protected access.

JSON 
{
  "date": "2022-09-07T08:51:15.000Z",
  "webhook": "password.activate",
  "email": "test@test.com",
  "subscription": {
    "code": "xxxxxxxx",
    "title": "123123",
    "password": "xxx-xxx-xxx"
  },
  "media": {
    "type": "media",
    "code": "xxxxxxxx",
    "title": "test"
  }
}

transcode.completed

Triggered after a specific video transcode (resolution) is successfully generated.

JSON 
{
  "code": "IWjDiieK",
  "date": "2025-10-09T09:33:06.849Z",
  "webhook": "transcode.completed",
  "id_media": 633199,
  "media": {
    "code": "IWjDiieK",
    "title": "Glavnaya.mp4",
    "quality": "240p"
  }
}
Field Description
code Unique media file identifier code
id_media Internal numeric media identifier
media.quality Resolution of the created transcode (e.g., 240p, 360p, 480p, 720p, 1080p)

Summary of Webhook Events

Event Name Trigger Description
media.created A new media file has been created
media.completed Media processing (transcodes/screenshots) is finished
media.failed Media processing has failed
ppv.bought A paid access (PPV) purchase was completed
live.started A live broadcast has started
live.stopped A live broadcast has ended
screenshots.completed Screenshot generation is finished
password.activate A user activated password-protected access
transcode.completed A specific video transcode resolution is ready

How to Configure Webhooks

Webhook notifications allow you to automate workflows, sync user data, and monitor system events in real time.

To configure your webhook endpoint URLs and subscribe to specific events, please contact Boomstream Support.