Для создания нового веб-хука необходимо указать следующие данные:
1.
Название веб-хука.*Есть возможность создавать одинаковые хуки, или хуки с одним и тем же названием. 2.
Событие.CoreApp предоставляет набор событий на платформе, по которым будет отправлен запрос на указанный хук:
- Заполнил форму сбора контактов (только в школе)
- Ученик присоединился к курсу
- Ученик начал урок в курсе
- Ученик закончил урок в курсе
- Ученик завершил курс
- Ученик удален из курса
- Новый урок опубликован в курсе
- Ученик сменил тариф
- Ученик оплатил тариф
- Доступ ученика к курсу истек
- Домашнее задание проверено учителем
- Домашнее задание отправлено учеником
- Live урок стартовал
3.
Метод вызова (GET или POST).Метод GET не имеет переменных. При использовании метода POST есть возможность добавлять переменные в тело запроса.
Стартовый набор переменных:
- user_id – ID ученика
- salebot_vk_id – ID чата SaleBot
- user_email – email ученика
- user_name – имя ученика
- course_id – ID курса
4. Запрашиваемый URL.
В данное поле необходимо вставить ссылку на сервис, с которым нужно провести интеграцию. Также в ссылку, с помощью двойных фигурных скобок, можно вставить доступную переменную, которая будет подставлена при вызове ссылки платформой. Например,
yandex.ru/{{user_id}}.
Список переменных:
{{user_id}} – ID ученика
{{salebot_vk_id}} – ID чата SaleBot
{{user_email}} – email ученика
{{user_name}} – имя ученика
{{course_id}} – ID курса
5.
Тело запроса (JSON)JSON может содержать следующие переменные (аналогичные пункту 3.)
- user_id – ID ученика
- salebot_vk_id – ID чата SaleBot
- user_email – email ученика
- user_name – имя ученика
- course_id – ID курса
и переменные выбранного события:
- lesson_id– ID урока
- lesson_name – название урока
- correct_count – количество правильных ответов
- total_count – количество вопросов в уроке
После заполнения обязательных полей созданный вебхук необходимо сохранить.
*Ограничений по количеству хуков нет.