Перейти на сайт

Webhooks

Создание и управление webhook на завершение мероприятия и выход всех участников

Вебхуки в МТС Линк позволяют получать уведомления о событиях, связанных с мероприятиями, в реальном времени. Они предназначены для интеграции платформы с внешними системами, чтобы автоматизировать процессы, такие как уведомления о регистрации участников, начале или завершении мероприятий. Вебхуки отправляются в формате JSON через HTTP-запросы (метод POST) на указанный URL. 

Ограничения:

- Возможность доступна на тарифах с API;

- МТС Линк позволяет добавить до 20 webhooks URL.

Список вебхуков

Ниже приведен полный список доступных вебхуков с кратким описанием. Подробности по каждому вебхуку доступны в отдельных статьях.


Название              Описание вебхука

eventSession.created

Создание мероприятия - cобытие создается и отправляется, когда мероприятие создано в личном кабинете

eventSession.startsAt.changed

Дата начала мероприятия изменена - когда в настройках мероприятия изменяется дата проведения

event.beforeReminder.sent

Отправлено напоминание о мероприятии - когда участникам отправляются письма с напоминанием, если в настройках напоминания включены

participation.acceptedWebinar

Регистрация участника - когда участник зарегистрировался на мероприятие

eventSession.started

Старт мероприятия - когда мероприятие запущено

eventSession.users.allLeft

Все участники покинули мероприятие - когда на мероприятии не осталось ни одного участника

eventSession.ended

Завершение мероприятия - когда нажимается кнопка завершения мероприятия

recordFile.ready

Готовность онлайн-записи - когда подготовлена запись

convertedRecord.ready

Завершение процесса конвертации - когда завершился процесс конвертации и файл *.mp4 готов для скачивания

transcription.ready

Готовность текстовой расшифровки - когда для завершённой встречи подготовилась текстовая расшифровка.


Добавление Webhook

Для добавления достаточно перейти в раздел, нажать кнопку "Добавить" и внести данные о названии, URL.

Также опционально можно передать секретный ключ в HTTP заголовке. Это можно использовать для проверки webhook на клиентской стороне (см статью Проверка подлинности webhook).

В случае, например, если на клиентской стороне используется самоподписный сертификат или сертификат с отозванным корневым сертификатом, то может быть ошибка валидации. Для игнорирования этого можно включить пункт "Игнорировать ошибки SSL сертификата".

Созданный webhook добавится в список

Существующий URL можно деактивировать и активировать повторно или удалить.

Рекомендации по использованию

  • Сервис обработки вебхуков должен быть быстрым и возвращать HTTP-код 200 в течение 5 секунд.

  • В случае неудачной отправки (нет ответа или код, отличный от 200) платформа повторяет попытку с увеличивающимся интервалом.

  • Используйте защищенные соединения (HTTPS) для URL вебхуков.

  • Логируйте входящие данные для отладки и анализа.

Полезные ссылки

👆 На этом пока всё