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