Что такое вебхуки битрикс 24
Готовые сценарии вебхуков для разработчиков
Мы значительно упростили работу разработчика приложений для Битрикс24.
В новом разделе Разработчикам мы предлагаем готовые сценарии для интеграции и доработки вашего Битрикс24, а также список всех созданных вебхуков и статистику их использования.
Готовые сценарии
В этой вкладке содержатся уже готовые сценарии с примерами кода и предустановленными параметрами на базе вебхуков и локальных приложений. Мы постарались добавить наиболее частые сценарии работы с вебхуками, но вы всегда можете создать свои интеграции.
В настройках вебхуков мы предоставляем простой генератор REST-запросов, который помогает в режиме онлайн подобрать нужные значения параметров для дальнейшего использования во внешних системах.
В генераторе запросов можно выбрать метод REST API, прочитать описание метода, скачать пример, добавить свои параметры. Здесь же можно выполнить сам запрос и получить результат, проверив работу вебхука.
Добавление прав доступа позволит ограничить выполнение запросов для определенных инструментов Битрикс24.
Готовые сценарии разбиты по категориям:
Интегрировать с внешними системами
Интеграции
Администратор Битрикс24 может видеть все интеграции в одном разделе – кто создал, какие события вызывают вебхуки, какие доступы предоставлены вебхуку или приложению. Учитываются все приложения, использующие REST API, в том числе и приложения из Маркета. Здесь же можно перейти к редактированию вебхука или удалить его.
Безопасность и сохранность данных
В вебхуке для вызова rest api и в адресе входящего вебхука всегда есть уникальный секретный код. В исходящем вебхуке также есть специальный секретный токен приложения. Они генерируются случайным образом при каждом создании вебхука:
Статистика
В этом разделе администратор Битрикс24 может просмотреть количество запросов по каждому вебхуку, внешней интеграции или приложению. Для удобства доступен фильтр и настройка колонок в списке вебхуков.
По умолчанию статистика показывается за последние 14 дней. Но через фильтр можно посмотреть статистику за последние 60 дней, при этом максимальный шаг в каждой выборке не должен превышать 14 дней.
Области применения вебхуков на портале Битрикс24
Под вебхуком понимается реакций стороннего по отношению Битрикс24 приложения – как правило некоторого PHP – файла – на событие его запуска. Это событие может быть вызвано из Битрикс24 через инициализацию данного файла (исходящий вебхук) или открытия данного файла на стороне стороннего сервера с вызовом методов REST API (входящий вебхук). Допускается и очень часто применяется комбинация исходящего и входящего вебхука.
Вебхуки настраиваются в разделе приложений Битрикс24, также на них можно сослаться из роботов \ триггеров сущностей CRM \ задач, выполнить запуск исходящего вебхука из бизнес-процесса. При этом сам вебхук представляет собой всего лишь гиперссылку: входящий содержит адрес корпоративного портала, ключ авторизации, и вызываемый метод REST API. Исходящий вебхук – это всего лишь ссылка на сторонний сайт, работающий в https – режиме, куда передается некоторый набор данных в виде POST-запроса.
Вебхуки представляют из себя предельно простой инструмент интеграции – для вызова методов REST API не надо проходит ресурсоемкую процедуру регистрации нового внешнего приложения, задействовать механизмы авторизации по протоколу OATH 2.0. Средством авторизации выступает уникальный ключ, хранящийся в ссылке входящего и запросе исходящего вебхука, в целях безопасности эти ключи рекомендуется периодически обновлять.
Как можно догадаться, вебхуки дают нам мощную свободу действий, ограниченную лишь библиотекой методов REST API. Приведем возможные кейсы применения вебхуков.
| Кейс | Вариант реализации | Комментарий |
| При изменении ответственного в сделке заменить ответственного в связанных с ним задачах | Связать событие обновления сделки с исходящим вебхуком, вызывающим входящие вебхуки: по запросу данных полей сделке, связанных со сделкой задачах, обновлению данных задач, если там другой ответственный | Данный вебхук готовы предоставить читателям данной статьи по запросу |
| Сменить стадию в сделке с «Товар отгружается» на «Товар отгружен клиенту» при поступлении информации из сторонней системы | На стадию сделки «Товар отгружен клиенту» вешается триггер со ссылкой на входящий вебхук, который запускается из логистической системы с параметрами указанной сделки | |
| Автоматически поставить задачу с заполнением чек – листа при переходе лида на новую стадию | Робот перехода сделки на новую стадию связывается с соответствующим входящим вебхуком | |
| При закрытии задачи приема сотрудника на работу в систему выпуска пропусков передается информация о новом сотруднике, указанном в постановщике по задаче | С событием обновления задачи связывается вебхук, проверяющий была ли задача закрыта, соответствует ли она задаче приема сотрудника на работу и передающий информацию по этому сотруднику в систему заказа пропусков | |
| Компания, организующая корпоративное мероприятие, ставит из своей системы событие в календари участников данного мероприятия | Из информационной системы компании, организующей корпоративное мероприятие, вызывается входящий вебхук, который добавляет данные в календари его участников на Битрикс24 | |
| Необходимо наполнить базу CRM при запуске корпоративного портала, одновременно создав контакты, компании и связанные с ними лиды и сделки | Запускается PHP-файл, забирающий сведения из источника и добавляющий сведения на корпоративный портал с помощью серии входящих вебхуков | Методы REST API имеет ограничение на число добавляемых записей в 50 штук. Для выполнения задачи необходимо вызывать серию методов в пакетном режиме |
Как видим большая свобода действий в применении вебхуков обусловлена следующими причинами: возможность делать стыковки со сторонними системами, поддерживающие функционал веб-сервисов, использованием при вызове вебхуков богатства функций языка PHP (массивов, циклов, условных операторов, собственных объектов, классов и их методов).
Скрипты входящих вебхуков предельно легко отлаживать (запускать скрипт в адресной строке и выводить результат выполнения с помощью команды print_r), их можно ставить на обработку в пакетномм режме через cron.
С другой стороны нельзя забывать про ограничения вебхуков: невозможность создавать через них массово тиражируемые решения с выкладкой на маркетплейс Битрикс24, необходимость в целях безопасности периодической замены ключей авторизации.
Автоматическое создание лидов в Битрикс24 при помощи входящего вебхука
Команда Битрикс24 внедрила очень простой и функциональный способ интеграции с CRM системой. Если ранее интеграция с Битрикс24 была не простой задачей, требующей отличной квалификации и знаний от вебмастеров и владельцев сайта, то теперь, с внедрением вебхуков, произвести интеграцию своего сайта с CRM системой может практически каждый желающий.
WebHooks Bitrix24 — механизм, который позволяет вам использовать практически весь богатый функционал Rest API Битрикс24, но при минимальных знаниях и трудозатрат.
И так, для организации автоматической передачи лидов при помощи вебхуков необходимо:
Для того, чтобы передать данные с Вашей формы обратной связи в лиды Битрикс24 необходимо создать входящий вебхук.
С 30.09.2020 Битрикс24 предложили готовые сценарии с примерами кода и предустановлеными параметрами на базе вебхуков.
Для этого следуем по инструкции:
После чего нажимаем на кнопку сохранить.
После сохранения появится код для авторизации вебхука и образец URL, который нужно использовать при отправке данных в Битрикс24.
2. Написать код для перехвата и передачи данных
Для завершения организации передачи данных с формы сайта в лиды Битрикс24 при помощи вебхуков необходимо всего лишь написать коротенький код.
Для того чтобы создать лид в Битрикс 24 можно использовать готовый метод Bitrix24::createLead().
Пример создания лида
Пример класса работы с Битрикс24
Для получения всех доступных полей для создания лида, можно использовать метод Bitrix24::getLeadFields().
Пример получения доступных полей для создания лида
После совершения всех этих действий, тестируйте.
Статья подготовлена техническими специалистами компании KONTUR для других технических специалистов, но будем рады помочь Вам интегрировать автоматическое создание лидов с Вашего сайта в Битрикс24.
Быстрая интеграция с Битрикс24 или волшебные вебхуки!
Как вы наверняка знаете, в Битрикс24 существует довольно обширный REST API, который позволяет добавлять функционал в облачный Битрикс24, а также создавать всевозможные интеграции с внешними системами. Используя методы REST вы можете создавать и модифицировать объекты CRM, задачи, публиковать сообщения в живую ленту и вообще, делать практически все, что угодно.
Но до недавнего времени существовало в этой идиллии одно небольшое «но», а именно, необходимость в реализации хитрого протокола авторизации OAuth 2.0. Несмотря на то, что этот протокол существует давно и используется многими игроками рынка, он все еще вызывает у разработчиков сложности в реализации «с нуля», а кроме того, имеет неприятное ограничение – если вам необходим постоянный автоматический обмен данными с Битрикс24 без участия пользователя, то из-за требований OAuth вам придется организовывать периодическое обновление авторизационных токенов, чтобы они «не протухли».
А ведь иногда просто надо быстренько связать конкретный Битрикс24 с конкретной внутренней системой, или скажем, отдельно взятой формой обратной связи. Или без лишних заморочек просто запостить в живую ленту портала отчеты из своей складской системы.
Я рад сообщить, что мы внедрили простой механизм интеграций с Битрикс24, который прекрасно подходит для использования in-house. Речь идет о всем известных вебхуках. А даже если и не всем известных, то многим 
Это механизм, который позволяет вам использовать практически весь наш богатый REST API, но при этом не заморачиваться с OAuth 2.0.
[spoiler]
Давайте на конкретном примере разберем, как это работает. Предположим, что у нас есть на сайте форма обратной связи по каким-то непонятным причинам еще не переведенная на прекрасные CRM-формы Битрикс24, и вместо того, чтобы использовать нормальные вещи мы все-таки хотим помучаться и допилить нашу существующую форму так, чтобы результат ее заполнения попадал в виде лида в Битрикс24.
Мы просто идем в раздел Приложения – Вебхуки, нажимаем кнопку «Добавить вебхук»
выбираем тип «Входящий вебхук» (ведь мы хотим из внешнего источника обращаться к Битрикс24, верно?) и видим форму редактирования параметров вебхука.
Указываем понятное нам самим название и описание вебхука, включаем галочку прав к нужному нам модулю Битрикс24. В данном случае нам нужен CRM, поскольку мы собираемся добавлять лиды.
После нажатия на кнопку сохранения мы обнаружим, что в форме появилась дополнительная информация
Как ни удивительно, но это все, что нам нужно.
Что значит «дернуть»? Например, это можно сделать вот так
На этом радость не заканчивается, ведь интеграция – штука двусторонняя и иногда хочется наоборот, что делать в своих или внешних системах, когда происходит некое изменение данных в Битрикс24. Ну, например, менеджер по продажам перевел сделку в Битрикс24 в нужный статус и в нашей внутренней ERP должен сформироваться наряд-заказ на запчасти из сделки.
Снова идем в Приложения – Вебхуки, но теперь добавляем «Исходящий вебхук». Форма будет отличаться, поскольку нам уже не нужно генерировать никакой ключ, зато нам нужно указать, при каком событии в Битрикс24 должен вызываться наш обработчик.
В обработчике пишем исключительно простой код – тупо логируем все, что к нам приходит.
Если теперь мы откроем любую сделку на редактирование и сохраним изменения, то обнаружим в логе вот такую историю:
Вебхуки представляются нам настолько простыми и полезными для решения оперативных вопросов, что мы включили этот функционал еще и в CRM-роботов!
Идем в настройки CRM, выбираем пункт Автоматизация и там нажимаем в кнопку «Сделки».
Чтобы не придумывать ничего сложного, воспользуемся тем же обработчиком исходящего вебхука, который у нас есть, но вызовем его в явном виде.
Нажмем кнопку «Настроить роботов», и у любого статуса сделки добавим робота, выбрав тип робота «Webhook». В открывшейся форме мы можем выбрать условия срабатывания робота, но самое главное, мы можем указать адрес обработчика и параметры, которые мы хотим в обработчик передать.
Для простоты давайте передадим туда в явном виде стадию сделки
Сохраним все это добро, перейдем в любую сделку и изменим ее стадию на ту, для которой только что сформировали робота. Сработает исходящий вебхук и в логах мы получим данные о сделке, полученные в виде параметров:
Вебхуки Битрикс24
В Bitrix24 присутствует достаточно просторный REST API, позволяющий расширить типовой функционал облачного Битрикса и производить различные интеграции со сторонними системами. Взаимодействуя с его методами у вас есть возможность создания и различной модификации объектов CRM, задач, публикаций сообщений в «живой ленте» и, фактически, реализации всего, что угодно.
Любая современная организация прибегает к интеграции с внешними сервисами.
Самый бесхитростный путь создания качественной связи – это интеграция собственного корпоративного портала. Вопрос лишь в том, как правильно это осуществить? Конечно, для таких целей есть REST API, позволяющий дополнять функционал облачного Bitrix, но взаимодействие с ним — задача далеко не из лёгких и требует достаточной квалификации со стороны разработчиков.
Однако у вас есть отличная возможность организовать единую связь портала Bitrix с внешними сервисами или отдельными формами без огромных затрат на программирование. Производить трансляцию отчётов из ваших складских систем прямиком в «живую ленту» можно при помощи webhook Битрикс24!
Это простой вариант REST-команд и событий, который не требует дополнительного написания приложений.
На данный момент не удалось найти универсальный способ для возможности программирования, который бы подошёл абсолютно всем. И, хоть webhook Битрикс24 достаточно легкий в использовании механизм, но доверять работу над ними лучше всего людям, с определённым багажом знаний.
Создание вебхуков Битрикс24
Примеры для входящих и исходящих. Для создания webhooks нужно перейти во вкладку «Приложения» (в левом меню), затем выбрать «Вебхуки».
Создание входящих webhooks
— «Название» и «Описание»;
— «Права доступа» — необходимо указать, к каким модулями Webhook должен получать доступ.
Комбинация авторизации должна находиться в строгой конфиденциальности!
Более подробно:
Создание исходящих webhooks
Данный код позволяет изнутри обработчика свериться, фактически ли поступил вызов от обработчика вашего Bitrix.