Войти в CRM    Перейти на сайт

Статьи в этом разделе

Webhooks

Черанёв Максим
  • Обновлено

Webhooks (вебхуки) предназначены для уведомления сторонних приложений о событиях, произошедших в CRM "Мой Класс". С помощью них вы можете осуществлять действия в других сервисах и приложениях, например, отправлять сообщения после получения платежей в "Мой Класс" или создания учеников, создавать лиды в другой системе после появления заявок в "Мой Класс", и т.д.

Если вам нужно осуществлять действия в нашей CRM по событиям в другом сервисе, например, создавать у нас контакт, если вы получили заявку через стороннюю форму, то вам нужны не вебхуки, а API.

Для работы с вебхуками нужно настроить их прием в вашем приложении, а также настроить в "Мой Класс" подписку, где выбрать, какие события отправлять в приложение.

Создание webhooks 

Перейдите в раздел CRM "Мой Класс" "Настройки - API и webhooks". Если у вас этот раздел скрыт, нажмите на "Еще".

___________2020-04-07_17-37-06-min.png

___________2020-04-07_17-38-02-min.png

Во вкладке "Webhooks" нажмите "+ Webhook".

___________2020-04-07_17-39-36-min.png

В открывшемся окне укажите название вебхука (для удобства), а также адрес сервера, на который вам нужно их отправлять. Как правило, адрес вы берете из того сервиса или приложения, в котором настраиваете ваши действия по вебхукам от нашей системы. 

ВАЖНО! Обратите внимание, что никакой дополнительной авторизации при отправке вебхуков нет, поэтому рекомендуется создавать адреса, которые сложно подобрать, например, https://website.com/hooks/4e0bcaa6-e4fa-4c50-bc7c-c09857788701

___________2020-04-07_17-41-55-min.png

Укажите филиалы ученика или программы/группы его записи, чтобы конкретизировать вебхук. Это необязательные параметры, можете оставить их не указанными, тогда вебхук будет срабатывать на действия в любом филиале или группе.

___________2020-04-07_17-43-15-min.png

Определите события, которые вам необходимы в вебхуке.

___________2020-04-07_17-45-25-min.png

Можно создать любое количество вебхуков и настроить таким образом любое количество подписок на события в нашей CRM. И в каждом вебхуке определить свои события.

Сохраните вебхук.

___________2020-04-07_17-45-59-min.png

Готово.

___________2020-04-07_17-47-14-min.png

Отправка Webhooks 

Вебхук отправляется сразу после наступления события, однако в некоторых случаях (при большой нагрузке) возможны задержки в отправке.

Вебхук считается отправленным, если сервер вернул код 2хх (200, 201, 203 и т.д.). Если сервер вернул другой код или не ответил в течение 5 секунд, то через 1 минуту производится повторная попытка. Всего по каждому событию делается максимум 5 попыток с интервалом в 1 минуту.

Если сервер не принял 50 запросов подряд, то подписка переводится в статус "отключена из-за ошибок", и вебхуки на нее не отправляются. При этом вы можете снова включить подписку в CRM. 

Структура Webhooks

ВАЖНО! Если вам не хватает данных, которые приходят в самом вебхуке, используйте их в связке с API. Например, в хуке приходит id занятия и некоторые данные - при необходимости можно запрашивать по API дополнительные данные занятия по его id.

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

Данные имеют следующую структуру:

{
    "companyId": <ID компании, в которой произошло событие>,
    "event": <код события>,
    "object": <объект, инициировавший событие>,
    "time": <отметка времени UNIX, указывающая, когда было отправлено уведомление о событии>,
    "changedFields": <массив, содержащий в себе список измененных полей сущности>,
    "init": <объект, который описывает, откуда и кем было инициировано событие>
}

Поле event

Содержит код события, которое произошло.

Доступны следующие события:

  • user_new - Ученик создан
  • user_changed - Информация об ученике изменилась
  • user_changed_state - Статус ученика изменился
  • user_birthday - Ученик отмечает день рождения
  • join_new - Создана запись в группу
  • join_changed - Информация о записи в группу изменилась
  • join_changed_state - Статус записи в группу изменился
  • class_new - Группа создана
  • class_changed - Информация о группе изменилась
  • class_start_days - Старт группы менее чем через 7 дней (отправляется раз в сутки)
  • class_start_hours - Старт группы менее чем через 6 часов (отправляется раз в час)
  • lesson_changed - Информация о занятии изменилась
  • lesson_start_days - Занятие начинается менее чем через 7 дней (отправляется раз в сутки)
  • lesson_start_hours - Занятие начинается через 6 часов (отправляется раз в час)
  • payment_new - Принят платеж
  • sub_new - Создание нового абонемента
  • debit_new - Новое списание у ученика
  • sub_lesson_in_debt - Занятие для записи проведено “в долг”
  • lesson_record_new - Создана запись на занятие
  • lesson_record_changed - Информация о записи на занятие изменилась
  • lesson_record_deleted - Запись на занятие удалена
  • sub_days_next_payment - Осталось менее 5 дней до внесения очередного платежа/долга по абонементу
  • sub_lessons_left - В абонементе осталось менее 5 посещений
  • sub_end_days - Абонемент заканчивается менее чем через 5 дней
  • user_consecutive_visit_missed_2 - Ученик имеет два пропуска подряд без уважительной причины
  • lesson_mark_set - Проставлена оценка
  • lesson_mark_deleted - Оценка удалена
  • lesson_task_new - Задание создано
  • lesson_task_changed - Задание изменено
  • task_new - Задача создана
  • task_changed - Задача изменена
  • task_deleted - Задача удалена

Поле object

Содержит объект, к которому относится событие.

  1. userId (integer) - ID ученика
  2. filials (array[integer]) - ID филиалов ученика
  3. attributes (array[object]) - Дополнительные атрибуты ученика
  4. name (string) - Полное имя ученика
  5. balans (integer) - Баланс ученика
  6. email (string) - Email ученика
  7. createdAt (string) - Дата создания ученика
  8. statusId (integer) - ID статуса ученика
  9. advSourceId (integer) - ID информационного источника (откуда ученик узнал о компании)
  10. responsibleId (integer) - ID ответственного менеджера
  11. statusReasonId (integer) - ID причины смены статуса ученика
  12. createSourceId (integer) - ID источника создания ученика
  13. prevStatusId (integer) - ID предыдущего статуса ученика
  14. prevStatusReasonId (integer) - ID причины смены предыдущего статуса ученика
  15. phone (string) - Номер телефона ученика

Используется в событиях: user_new, user_changed, user_changed_state, user_birthday.

Объект записи в группу

  1. joinId (integer) - ID заявки
  2. price (integer) - Цена (для групп с разовой оплатой)
  3. userId (integer) - ID ученика
  4. classId (integer) - ID группы
  5. comment (string) - Комментарий
  6. autoJoin (boolean) - Автоматически записывать в статусе “Учится” на все занятия в группе
  7. managerId (integer) - ID ответственного сотрудника
  8. remindSum (integer) - Сумма долга к оплате
  9. createdAt (string) - Дата создания
  10. statusId (integer) - ID статуса заявки
  11. advSourceId (integer) - ID информационного источника (откуда ученик узнал о компании)
  12. prevStatusId (integer) - ID предыдущего статуса заявки
  13. createSourceId (integer) - ID источника создания
  14. statusChangeReasonId (integer) - ID причины смены статуса
  15. prevStatusChangeReasonId (integer) - ID причины смены предыдущего статуса
  16. remindDate (string) - Срок оплаты долга
  17. stats (object) - Статистика по записи

Используется в событиях: join_new, join_changed, join_changed_state.

Объект группы

  1. classId (integer) - ID группы
  2. name (string) - Название
  3. color (string) - Цвет
  4. price (integer) - Цена
  5. comment (string) - Комментарий
  6. statusId (integer) - ID статуса
  7. courseId (integer) - ID программы
  8. courseName (string) - название программы
  9. payPass (boolean) - Списывать посещения из абонемента за пропуски без уваж. причины
  10. showDates (boolean) - Отобажение даты начала у названия группы
  11. maxStudents (integer) - Максимальное количество студентов
  12. filialId (integer) - ID филиала
  13. priceComment (string) - Комментарий к цене
  14. priceForWidget (string) - Цена для виджетов
  15. createdAt (string) - Дата создания
  16. payType (string) - Способ оплаты за обучение. full - разово, lessons - за занятия
  17. beginDate (string) - Старт занятий

Используется в событиях: class_new, class_changed, class_start_days, class_start_hours.

Объект занятия

  1. lessonId (integer) - ID занятия
  2. topic (string) - Тема занятия
  3. endTime (string) - Время окончания занятия
  4. classId (integer) - ID группы
  5. status (integer) - Статус
  6. createdAt (string) - Дата создания
  7. beginTime (string) - Время начала
  8. description (string) - Описание занятия
  9. filialId (integer) - ID филиала
  10. roomId (integer) - ID аудитории
  11. date (string) - Дата начала занятия
  12. params (object) - Параметры занятия, в объекте хранятся массивы объектов webinars и videos

Используется в событиях: lesson_changed, lesson_start_days, lesson_start_hours.

Объект платежа

  1. userId (integer) - ID ученика
  2. paymentId (integer) - ID платежа
  3. summa (integer) - Сумма платежа
  4. userSubscriptionId (integer) - ID абонемента ученика
  5. date (string) - Дата оплаты

Используется в событиях: payment_new.

Объект списания

  1. userId (integer) - ID ученика
  2. paymentId (integer) - ID платежа
  3. invoiceId (integer) - ID счета
  4. summa (integer) - Сумма списания
  5. classId (integer) - ID группы
  6. saleId (integer) - ID продажи товара
  7. userSubscriptionId (integer) - ID абонемента ученика
  8. date (string) - Дата списания

Используется в событиях: debit_new.

Объект записи на занятие

  1. lessonRecordId (integer) - ID записи на занятие
  2. free (boolean) - Бесплатная запись
  3. test (boolean) - Пробная запись на занятие
  4. skip (boolean) - Не учитывать запись в количестве занятых мест
  5. visit (boolean) - Статус посещения
  6. userId (integer) - ID ученика
  7. lessonId (integer) - ID занятия
  8. createdAt (string) - Дата создания
  9. goodReason (boolean) - Уважительная причина отсутствия
  10. joinStats (object) - Статистика записи в группу

Используется в событиях: sub_lesson_in_debt, lesson_record_new, lesson_record_changed.

Объект отмененной записи

  1. classId (integer) - ID группы
  2. userId (integer) - ID ученика
  3. lessonId (integer) - ID занятия

Используется в событиях: lesson_record_deleted.

Объект абонемента пользователя

  1. userSubscriptionId (integer) - ID абонемента
  2. userId (integer) - ID ученика
  3. statusId (integer) - ID статуса абонемента
  4. visitedCount (integer) - Количество списанных занятий в абонементе
  5. visitCount (integer) - Количество занятий в абонементе
  6. remindSumm (integer) - Сумма долга к оплате
  7. endDate (string) - Дата окончания действия
  8. sellDate (string) - Дата продажи
  9. beginDate (string) - Дата начала действия
  10. remindDate (string) - Срок оплаты долга

Используется в событиях: sub_days_next_payment, sub_lessons_left, sub_end_days.

Объект двух пропущенных занятий подряд

  1. classId (integer) - ID группы
  2. userId (integer) - ID ученика
  3. lessonIds (array[integer]) - ID последних двух пропущенных занятий

Используется в событиях: user_consecutive_visit_missed_2.

Объект оценки

  1. lessonId (integer) - ID занятия
  2. userId (integer) - ID ученика
  3. type (string) - Тип оценки, home либо lesson
  4. value (integer) - Оценка

Используется в событиях: lesson_mark_set, lesson_mark_deleted.

Объект задания

  1. lessonId (integer) - ID занятия
  2. files (array[integer]) - Список ID прикрепленных файлов
  3. type (string) - Тип задания, home либо lesson
  4. showToUser (boolean) - Доступно ли задание ученику для просмотра

Используется в событиях: lesson_task_new, lesson_task_changed.

Объект задачи

  1. lessonId (integer) - ID задачи
  2. body (string) - Текст задачи
  3. companyId (integer) - ID компании
  4. beginDate (string) - Начало задачи
  5. endDate (string) - Окончание задачиisAllDay (boolean) - Задача на весь день
  6. isComplete (boolean) - Задача выполнена
  7. userId (integer) - ID ученика
  8. classIds (array[integer]) - Список связанных групп
  9. filialIds (array[integer]) - Список связанных филиалов
  10. categoryId (integer) - ID категории задачи
  11. invoiceId (integer) - ID счета
  12. managerIds (array[integer]) - Список id ответственных сотрудников

Используется в событиях: task_new - Задача создана, task_changed - задача изменена

Объект удаленной задачи

  1. taskId (integer) - ID задачи

Используется в событиях: task_deleted - Задание удалено

Поле Init

Содержит информацию о том, кто инициировал событие. Формат объекта init:

{
    "from": "CRM", // Откуда было вызвано событие
    "managerId": 65 // ID менеджера
}

Поле from может принимать значения:

  • CRM - событие вызвано из CRM, в init добавляется managerId - ID менеджера
  • import - событие вызвано из импорта, в init добавляется managerId - ID менеджера
  • LK - событие вызвано из Личного Кабинета ученика, в init добавляется userId - ID ученика
  • widget - событие вызвано из Виджетов, в init добавляется widgetId - ID виджета
  • integration - событие вызвано из Интеграции, в init добавляется integrationId - ID интеграции
  • API - событие вызвано из API

Поле changedFields

Содержит массив измененных полей. Доступно для следующих событий:

  • user_changed - Информация об ученике изменилась
  • user_changed_state - Статус ученика изменился
  • join_changed - Информация о записи в группу изменилась
  • join_changed_state - Статус записи в группу изменился
  • class_changed - Информация о группе изменилась
  • lesson_changed - Информация о занятии изменилась
  • lesson_record_changed - Информация о записи на занятие изменилась
  • lesson_task_changed - Информация о задании изменилась
Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 1 из 1
Еще есть вопросы? Отправить запрос
В начало

Похожие статьи

На базе технологии Zendesk