You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Next »

Вебхук (WebHook) - упрощенный вариант REST-событий и REST-команд, не требующий написания приложения.

Для создания вебхуков необходимо перейти в раздел Приложения - Вебхуки (https://helpdesk.bitrix24.ru/open/5408147/)

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

Создать 6 исходящих вебхуков на адрес Логуса

  • Создание контакта
  • Обновление контакта
  • Создание компании
  • Обновление компании
  • Создание сделки
  • Обновление сделки

В поле "Адрес обработчика" необходимо указать внешний адрес сервера Логуса (т.е. перед этим нужно настроить port-forwarding ("проброс" портов) на внутренний адрес сервера Логуса).

Если Битрикс развёрнут локально у клиента, а не в облаке, то необходимо убедиться, что сервер Логуса доступен по локальному адресу с сервера Битрикс, например командой.

curl http://logus_server:8080/

где logus_server - внутренний адрес сервера Логуса.


Бывали случаи, когда теряли много времени, а сервер Битрикс оказывался в отдельном VLAN/DMZ и не имел доступа к серверу Логуса. В этом случае и сам Битрикс будет подвисать при операциях, требующих вызова вебхука - ожидать таймаута по 30 секунд.

Поля «Название» и «Комментарий» заполнить по желанию.

В поле «Тип события» отметить тип, соответствующий одному из 6 событий.

После сохранения вебхука будет сгенерирован Код авторизации в виде строки из случайных знаков.

Этот код позволит внутри модуля Битрикс проверить, действительно ли обработчик вызван вашим Битрикс.

Проверку вебхуков можно отключить <CheckWebHookAuthorizationCodes>False</CheckWebHookAuthorizationCodes>.

Для безопасной и корректной работы синхронизации следует оставлять проверку включённой. <CheckWebHookAuthorizationCodes>True</CheckWebHookAuthorizationCodes>.

При активной проверке все коды авторизации необходимо добавить в конфиг в секции <WebHookAuthorizationCodes>. Коды перечисляются через запятую (пробелы, табуляции и переносы на новую строку допускаются, порядок кодов значения не имеет).

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

Создать один входящий вебхук, и предоставить ему права к следующим разделам: Пользователи (user), Списки (lists) и CRM (crm).

После сохранения изменений будет сформирован уникальный код.

Для настройки вебхука необходимо в logus.local.config в секции <Bitrix> в поле <WebHookId> прописать уникальный код для авторизации вебхука.

Внимание! Данный код является конфиденциальной информацией. Его необходимо держать в секрете.

Вместе с кодом будет представлен образец URL, который нужно использовать при отправке данных из Логуса в Bitrix24 (для разработчиков системы):
https://********.bitrix24.ru/rest/1/5sb---------1wg/profile/ 
где:

  • ******** - имя вашего портала;
  • /rest/ - указание системе на то, что данный адрес относится в вебхукам;
  • /1/ - идентификатор пользователя, создавшего вебхук. Под правами этого пользователя будет работать этот вебхук.
  • /5sb---------1wg/ - секретный код;
  • /profile/ - метод REST, который вы хотите выполнить, обращаясь к вебхуку. Разработчик должен сам подобрать метод из REST API в зависимости от целей создания вебхука.




  • No labels