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

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

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

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

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

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

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

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

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

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

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

Библиотеки для работы

JS

Если ваше приложение реализует пользовательский интерфейс внутри Битрикс24, выводится на специальной странице или использует инструменты встройки, нужно воспользоваться возможностями специальной JS-библиотеки. Она представляет собой, JS SDK для REST что позволяет обращаться к REST прямо из front-end вашего приложения не погружаясь в реализацию авторизации по OAuth 2.0, предлагает ряд дополнительных функций для взаимодействия пользовательского интерфейса вашего приложения с интерфейсом Битрикс24. Для внешних приложений и вебхуков библиотека использоваться не может.

Подключается библиотека следующим образом:

<script src="//api.bitrix24.com/api/v1/"></script>

PHP

Использование REST API позволяет достаточно просто решать многие задачи интеграции внешних источников или систем с Битрикс24.

Crest небольшой PHPSDK для использования REST API Битрикс24 в локальных приложениях, тиражных приложениях или через вебхуки. Библиотеку можно скачать с репозитория.