Webhooks (функции обратного вызова)

Общая информация

Ссылки на данные ф-ции задаются в настройках CRM (Настройки->Интеграция->Webhooks и Настройки->Интеграция->Телефония).

Авторизация

Для проверки подлинности вызова можно использовать произвольный ключ (задаётся в Настройки->Интеграция->Webhooks, не обязателен).

Данный ключ придёт в качестве параметра «key» в каждый из нижеуказанных методов (для краткости не указывается в списке параметров).

Однако более надёжный способ - использовать https и выполнять проверку клиентского сертификата на валидность и поле Common Name (CN), которое должно быть равным «*.t8s.ru».

Возвращаемые данные

Возвращаемые данные (если они предусмотрены) должны быть представлены в виде JSON.

В случае ошибки вебхук-методы должны возвращать текст ошибки в поле «Error». Этот текст может быть отображён для пользователя CRM.

Если возвращаемый код состояния HTTP свидетельствует об ошибке, так же будет отображён соответствующий ему текст ошибки, но текст в поле «Error» имеет больший приоритет.

События CRM

Автодействие

Вызывается в качестве автодействия в ответ на срабатывание какого-либо триггера.
Триггеры и автодействия добавляются в разделе Настройки->Ученики->Автодействия.
URL данного вебхука устанавливается в разделе Настройки->Интеграция->API->Webhooks.
Если URL не указан, вебхук не будет вызван, ошибкой это не считается (таким образом можно временно отключать вебхуки от всех автодействий).

Список параметров:

TriggerType	Тип триггера. Возможные значения описаны ниже.
ObjectType	Тип объекта (сущность), к которому относится триггер. Возможные значения: "Lead" - лид, "StudentClient" - клиент-ученик.
ObjectId	Числовой идентификатор данного объекта (т.е. лида или клиента).

Возможные значения параметра TriggerType:

Created	Добавление нового объекта (лида или ученика).
StatusSet	Установка статуса.
TrialLessonAdded	Запись лида на пробный урок.
TrialLessonVisited	Посещение лидом пробного урока.
EntranceTestAdded	Запись на вступительный тест.
PreEntryEdUnitAdded	Предварительная запись лида в уч. единицу.
AttachedToStudent	Прикрепление лида к ученику.
BillAdded	Выставление счёта ученику.
BillPaid	Оплата счёта учеником.

Возвращаемых данных не предусмотрено.

События API для телефонии

Описаны в соседнем разделе "API для телефонии".