Первый шаг — подключить тариф Профи или Гуру на вашем аккаунте. Он позволяет запускать курсы и использовать в данных курсах веб-хуки.

Далее, откройте вкладку «Курсы». Выберите курс, в котором необходимо настроить веб-хуки. В меню настроек курса выберите пункт «Веб-хуки».

Далее, нажмите на кнопку «Добавить веб-хук».

Для создания нового веб-хука необходимо указать следующие данные:

1. Название веб-хука.
*Есть возможность создавать одинаковые хуки, или хуки с одним и тем же названием.

2. Событие.
CoreApp предоставляет набор событий на платформе, по которым будет отправлен запрос на указанный хук:

• Ученик присоединился к курсу
• Ученик начал урок в курсе
• Ученик закончил урок в курсе
• Ученик удален из курса
• Доступ ученика к курсу истек
• Новый урок опубликован в курсе
• Домашнее задание проверено учителем
• Домашнее задание отправлено учеником

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 – количество вопросов в уроке

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

*Ограничений по количеству хуков нет.

Созданный веб-хук можно редактировать или удалить.

Объединение веб-хуков

Вы можете объединить уведомления о событиях и задать промежуток времени, через который они будут приходить. Например, уведомления о событиях приходят раз в 180 минут. 

Пример интеграции CoreApp и Unisender в статье из нашей Библиотеки готовых решений.

Готово! Настройка веб-хука завершена. Теперь вы будете получать уведомления о событиях в курсе.

Остались вопросы?
Обращайтесь в нашу службу поддержки через виджет на сайте CoreApp в правом нижнем углу или по адресу help@coreapp.ai.