Отправка Webhooks по событиям

11.06.2021

О Вебхуках

Для целей интеграции с внешними системами, наравне с Rest API, вам может быть полезно "ловить" некоторые события в режиме рального времени, для этого подходят Вебхуки (Webhooks).

Как создать

Создать Вебхуки можно в меню Настройки -> Webhooks

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

Формат отправляемых данных

При срабатывании вебхука на ваш адрес отправляется полностью весь объект (ресурс), формат данных JSON, описание полей ресурсов можно найти в документации нашего Rest API - под списком методов API идет перечисление всех ресурсов, если развернуть ресурс, можно увидеть набор его полей с примером заполнения и схемой-описанием.

Названия ресурсов (объектов):

Помещение - Room

Сделка - Deal

Приемка - Inspection

Техзаявка - Claim

Клиент - User

События

На каждый из ресурсов выше отправляется два вида вебхуков:

при создании объекта
при изменении объекта.