Webhook-события Boomstream
В этом документе приведён список всех доступных webhook-событий платформы Boomstream. Webhook-уведомления позволяют автоматизировать процессы и интегрировать платформу с внешними системами.
media.created
Событие возникает при создании нового медиафайла.
{
"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
Событие возникает при завершении обработки медиафайла (создание транскодов, скриншотов и т.д.).
{
"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
Событие возникает при ошибке обработки медиафайла.
{
"date": "2022-06-09T07:10:25.590Z",
"webhook": "media.failed",
"media": {
"code": "xxxxxxxx",
"title": "example"
}
}
ppv.bought
Событие возникает при совершении покупки платного доступа.
{
"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
Событие возникает при начале трансляции.
{
"date": "2022-06-07T13:41:02.431Z",
"custom_field": "",
"webhook": "live.started",
"media": {
"code": "xxxxxxxx",
"title": "example"
}
}
live.stopped
Событие возникает при остановке трансляции.
{
"date": "2022-06-07T09:06:47.757Z",
"custom_field": "",
"webhook": "live.stopped",
"media": {
"code": "xxxxxxxx",
"title": "example"
}
}
screenshots.completed
Событие возникает после завершения генерации скриншотов для медиафайла.
{
"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"
}
]
}
| Поле | Описание |
|---|---|
code |
Код скриншота |
width |
Ширина изображения |
height |
Высота изображения |
isPoster |
Является ли изображение постером (yes/no) |
url |
Прямая ссылка на скриншот |
password.activate
Событие возникает при активации пароля доступа.
{
"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
Событие возникает после завершения создания транскода для медиафайла.
{
"code": "IWjDiieK",
"date": "2025-10-09T09:33:06.849Z",
"webhook": "transcode.completed",
"id_media": 633199,
"media": {
"code": "IWjDiieK",
"title": "Glavnaya.mp4",
"quality": "240p"
}
}
| Поле | Описание |
|---|---|
code |
Код медиафайла |
id_media |
Внутренний идентификатор медиафайла |
media.quality |
Качество созданного транскода (240p, 360p, 480p, 720p, 1080p) |
Сводная таблица событий
| Событие | Описание |
|---|---|
media.created |
Медиафайл создан |
media.completed |
Обработка медиафайла завершена |
media.failed |
Ошибка обработки медиафайла |
ppv.bought |
Совершена покупка платного доступа |
live.started |
Трансляция началась |
live.stopped |
Трансляция остановлена |
screenshots.completed |
Генерация скриншотов завершена |
password.activate |
Пароль доступа активирован |
transcode.completed |
Создание транскода завершено |
Использование
Webhook-уведомления позволяют интегрировать Boomstream с внешними системами, автоматизировать учёт покупок, отслеживать статус обработки видео и многое другое.
Для настройки webhook-адресов обратитесь в поддержку Boomstream.