Webhook-уведомления в Boomstream: настройка и события
Коротко о главном:
Webhook-уведомления (URL-нотификации) в Boomstream позволяют автоматически оповещать ваш сервер о ключевых событиях на платформе: создании и обработке видео, покупках, старте и остановке трансляций, активации паролей. При наступлении события платформа отправляет POST-запрос с кодом медиа на указанный URL. Если сервер не возвращает HTTP 200, система повторяет запрос через 10 и 15 минут. Настройка выполняется в личном кабинете или через API.
Как это работает
Для оповещения о различного вида событиях на платформе предусмотрена URL-нотификация (вебхуки). Этот механизм позволяет интегрировать Boomstream с вашими внутренними системами, CRM или сайтом для автоматического выполнения действий при наступлении определённых событий.
После того как наступит событие, указанное в описании вебхука, на указанный в настройках проекта URL будет послан POST-запрос, содержащий код видеофайла или трансляции (POST-параметр code).
Обработка ответов
| Ответ сервера | Действие платформы |
|---|---|
| HTTP 200 | Положительный ответ — уведомление считается успешным и удаляется из очереди |
| Другой HTTP код | Уведомление считается неудачным и будет повторено через 10 минут |
| Третья попытка | Выполняется через 15 минут от первой попытки, после чего отправка останавливается |
Рекомендация: убедитесь, что ваш сервер обрабатывает входящие POST-запросы быстро и всегда возвращает статус 200 OK. Если внутренняя логика обработки занимает время, ставьте задачу в фоновую очередь, чтобы не задержать ответ сервера.
Список доступных вебхуков
| Событие | Описание |
|---|---|
media.created |
Успешное создание видеофайла (загрузка началась) |
media.completed |
Успешная обработка видеофайла (создание транскодов завершено) |
media.failed |
Во время обработки видеофайла произошла ошибка |
ppv.bought |
Успешная покупка платного доступа к видео |
live.started |
Старт live-трансляции (поступление RTMP-потока на сервер) |
live.stopped |
Остановка live-трансляции (прекращение потока) |
screenshots.completed |
Созданы обложки (скриншоты) для медиа |
password.activate |
Пароль доступа активирован зрителем |
transcode.completed |
Создание конкретного транскода (качества) завершено |
Более подробная техническая информация и примеры JSON-ответов доступны в документации по вебхукам.
Настройка вебхуков
Создать и управлять уведомлениями вы можете двумя способами:
| Способ | Описание |
|---|---|
| В личном кабинете | Перейдите в Настройки проекта → раздел Webhooks. Там можно добавить URL и выбрать отслеживаемые события |
| Через API | Программное создание и удаление вебхуков. Документация API |
Дополнительные уведомления
Если вам нужны дополнительные нотификации, не входящие в стандартный список (например, специфические события для кастомных интеграций), напишите нам на support@boomstream.com. Наша команда рассмотрит возможность добавления нужных триггеров.
Частые вопросы (FAQ)
Что такое webhook-уведомления в Boomstream?
Webhook-уведомления (URL-нотификации) — это механизм, при котором платформа автоматически отправляет POST-запрос на указанный вами URL при наступлении определённых событий (загрузка видео, покупка, старт трансляции и т.д.).
Какие данные передаются в POST-запросе вебхука?
В POST-запросе передаётся параметр code, который содержит уникальный код видеофайла или трансляции, к которой относится событие.
Что произойдёт, если мой сервер не ответит HTTP 200 на webhook?
Если сервер вернёт любой другой HTTP-код или не ответит вовсе, Boomstream повторит отправку уведомления через 10 минут. Третья и последняя попытка будет выполнена через 15 минут после первой, после чего отправка остановится.
Можно ли отслеживать покупки платного видео через вебхуки?
Да, для этого предусмотрено событие ppv.bought, которое срабатывает при успешной покупке платного доступа к видео или трансляции. Это позволяет автоматически выдавать доступы в вашей CRM или LMS.
Где настроить вебхуки в личном кабинете Boomstream?
Вебхуки настраиваются в личном кабинете: перейдите в Настройки проекта, затем в раздел Webhooks. Также доступно программное управление через API.
Можно ли добавить собственные события для вебхуков?
Стандартный список событий фиксирован. Если вам нужны дополнительные нотификации, не входящие в стандартный список, напишите в поддержку на support@boomstream.com для обсуждения возможности их добавления.