Webhooks

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

МТС Линк позволяет добавить до 20 webhooks URL, которые вызываются при следующих событиях:

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

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

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

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

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

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

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

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

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

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

Добавление Webhook

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

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

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

• При отправке вебхука ожидается ответ в течение 5 секунд. Если принимающий сервис не ответит в течение этого времени или выдаст ошибку (код HTTP отличный от 200), то попытка отправки считается неудачной. Попытка будет повторена через некоторое время с увеличивающимся интервалом. Поэтому сервис обработки вебхуков должен быть максимально быстрым.

Данные, которые передаются при вызове webhook

• Создание мероприятия

  { 
  "event": "eventSession.created", // Тип события
  "occurredAt": "2023-04-21T16:00+03:00", // Дата и время, когда произошло событие 
  "data": { "eventSessionId": 1969088081 // id мероприятия }
  }

• Дата начала мероприятия изменена

  { 
  "event": "eventSession.startsAt.changed", // Тип события
  "occurredAt": "2023-04-21T16:00+03:00", // Дата и время, когда произошло событие 
  "data": {
     "eventSessionId": 33333333, // id мероприятия
     "eventSessionNewStartsAt": "2023-12-05T06:37:00+03:00", // Новая дата
     "eventSessionOldStartsAt": "2023-12-05T06:18:00+03:00" // Старая дата
     }
  }

• Отправлено напоминание о мероприятии

  { 
  "event": "event.beforeReminder.sent", // Тип события
  "occurredAt": "2023-04-21T16:00+03:00", // Дата и время, когда произошло событие 
  "data": {
     "eventUrl": "https://my.mts-link.ru/11111111/2222222222", // Ссылка мероприятия
     "eventName": "Новое мероприятие сегодня", // Название мероприятия
     "reminderDate": "2023-12-05T06:22:00+03:00", // Дата и время напоминания, которое отправлено
     "timezoneName": "Europe/Moscow", // Часовой пояс
     "eventStartsAt": "2023-12-05T06:37:00+03:00", // Дата начала мероприятия
     "eventSessionId": 33333333, // id мероприятия
     "eventDescription": null, // Описание, заданное в настройках мероприятия
     }
  }

• Регистрация участника

  {
  "event": "participation.acceptedWebinar", // Тип события
  "occurredAt": "2024-02-02T15:54:59+03:00", // Дата и время, когда произошло событие 
  "data": {
     "name": "Евгений", // Имя, указанное участником при регистрации
     "role": "GUEST", // Роль на мероприятии
     "email": "test@test.ru", // Почта
     "userId": 671095, // Идентификатор участника
     "referrer": null, // Источник перехода на форму регистрации
     "secondName": "Сидоров", // Фамилия
     "paymentStatus": "NOT_PAID", // Статус оплаты
     "eventSessionId": 1918814158, // id мероприятия
     "additionalFieldValues": [ // Дополнительные поля формы регистрации
        {"key": "2928e19c705428df3c9f1e6d4ea8042f","label": "Телефон", "value": "89999999999"},
        {"key": "069c9cb17c0aca1e499f3a00fdeb9b3a","label": "Город", "value": "Москва"},
        {"key": "d9800911a9155661a44b8aae9566f0f0","label": "Компания", "value": "Организация"},
        {"key": "b972361926f1a3e5e04c9caddf77f28d","label": "Должность", "value": "Сотрудник"}
     ]
  }
  }

• Старт мероприятия

  { 
  "event": "eventSession.started", // Тип события
  "occurredAt": "2023-04-21T16:00+03:00", // Дата и время, когда произошло событие 
  "data": {
     "eventSessionId": 33333333, // id мероприятия
     }
  }

• Все участники покинули мероприятие

  { 
  "event": "eventSession.users.allLeft", // Тип события
  "occurredAt": "2023-04-21T16:00+03:00", // Дата и время, когда произошло событие 
  "data": { "eventSessionId": 33333333 // id мероприятия }
  }

• Завершение мероприятия

  { 
  "event": "eventSession.ended", // Тип события
  "occurredAt": "2023-04-21T16:00+03:00", // Дата и время, когда произошло событие 
  "data": {
     "eventSessionId": 33333333, // id мероприятия
     }
  }

• Готовность онлайн-записи

  { 
  "event": "recordFile.ready", // Тип события
  "occurredAt": "2023-04-21T16:00+03:00", // Дата и время, когда произошло событие 
  "data": {
     "recordId": 5555555555, // id записи
     "eventSessionId": 3333333 // id мероприятия
     }
  }

• Завершение процесса конвертации

  { 
  "event": "convertedRecord.ready", // Тип события
  "occurredAt": "2023-04-21T16:00+03:00", // Дата и время, когда произошло событие 
  "data": {
     "convertedRecordId": 728377235 // id сконвертированного файла
     "eventSessionId": 3333333 // id мероприятия
     }
  }