Что такое вебхуки

Вебхуки служат для взаимодействия портала Битрикс24 с внешними обработчиками данных, бывают Входящие и Исходящие вебхуки.

Вебхук, это механизм оповещения одной системы о событиях в другой. Например, на складе товар отгрузили клиенту, информация об этом из системы складского учета через специальную ссылку вебхука поступает в Битрикс 24. Ссылка через которую произошло такое взаимодействие двух программ, называется вебхуком.

Какие бывают вебхуки

Вебхуки позволяют выполнять простые интеграции со сторонними системами, при этом получая стабильный и гарантированный результат. По принципу работы они подразделяются на два типа:

Входящий вебхук активируется, если к порталу был запрос по специальной ссылке, сгенерированной заранее
Исходящий вебхук выполнение определенного события инициирует отправку данных на заданный адрес, где они могут дальше обрабатываться

Такая автоматизация позволяет реализовать различные сценарии использования вебхуков для повышения эффективности работы портала. Использование вебхуков имеет свои особенности, о которых нужно помнить:

Ключи доступа не имеют срока годности, потеря ключа означает потерю контроля над функционалом вебхука
Возможности этой технологии ограничены, эти ограничения вызваны особенностями REST и обойти их не получится
В облачной редакции портала есть лимит на частоту запросов, он не должен превышать 2 запроса в секунду

В коробочной версии Битрикс24 ограничений по частоте запросов нет, но все остальные особенности сохраняются.

Входящие вебхуки

Входящие вебхуки поступают изначально в ваш портал. Для примера, хотим получить список задач некоторого юзера, послали соответствующий запрос в портал, нам вернулся некоторый массив данных. Хотим получить информацию о сделке с айди равным 5211, аналогично посылаем соответствующий запрос в портал, получаем информацию о сделке.

Пример URL, для вызова REST с подробный разбор URL-ссылки:

https://********bitrix24.ru/rest/313/seycsj9qf5hbgrua/profile/

******* наименование корпоративного портала
/rest/ подтверждение того, что этот адрес относиться к Битрикс24 вебхукам
/313/ ID пользователя, который создал webhooks
/seycsj9qf5hbgrua/ секретный код
/profile/ метод REST выполняемый вами, когда вы прибегаете к использованию webhooks. Разработчик должен самостоятельно заняться подбором нужного метода. Метод будет напрямую зависеть от конечной цели создания вебхука в Битрикс24

Исходящие вебхуки

Исходящие вебхуки инициируются порталом и отправляются из него во внешний обработчик. Исходящие вебхуки, срабатывают при наступлении определенных событий в портале. Например, на портале добавилась новая задача, для системы это событие. В этот момент, во внешний обработчик из портала посылается некоторый массив данных, содержащий информацию об этом событии. Важно, чтобы обработчик смог корректно принять и обработать поступивший к нему запрос. Под внешним обработчиком, понимаем некоторый ресурс, имеющий url с https и на нем уже обработка поступившего POST-запроса.

Требования для работы с вебхуками и документация

Для работы с вебхуками нужна подписка на Маркет. Она оформляется в соответствующем разделе левого меню портала.

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

Рекомендую установить бесплатное приложение Документация по REST API. В нем можно найти доку и отправить соответствующий вебхук для теста. Установленное приложение появится в разделе Установленных приложений:

Также не лишним будет использовать Документацию по REST.