В разделе Разработчикам мы собрали инструменты для доработки возможностей Битрикс24. Здесь вы сможете:
- создать вебхук,
- создать приложение,
- найти все созданные вебхуки и приложения,
- посмотреть статистику запросов по вебхукам и приложениям.
Подписка на Битрикс24 Маркетплейс
Как создать вебхук
На вкладке Готовые сценарии есть примеры популярных сценариев для создания вебхуков: создать чат-бота для информирования сотрудников или добавить в карточку звонка скрипт продаж. Если вы не нашли нужный сценарий, можно создать свой вебхук. Создавать вебхуки может любой пользователь.
Выберите сценарий и перейдите к настройкам.
Вебхук для вызова REST API. В этом поле автоматически генерируется секретный код вебхука. Код доступен только создателю вебхука. Если администратор Битрикс24 отредактирует чужой вебхук, секретный код обновится, а владельцем этого вебхука станет администратор.
Вебхуки. Быстрый старт
Генератор REST-запросов. С помощью генератора можно подобрать нужные значения методов и параметров для доработки инструментов. Вы можете прочитать описание методов и параметров, скачать пример с параметрами на языке php.
Описание методов в документации по REST
URL. В этом поле URL формируется автоматически из настроенных методов и параметров. Его можно использовать во внешних системах для выполнения запроса.
URL состоит из нескольких параметров:
********24.bitrix24.ru— адрес вашего Битрикс24./rest— показывает, что работа ведётся через rest с вебхуками./7— идентификатор пользователя, который создал вебхук./hv**********ffgs— секретный код. С помощью этого кода можно просматривать, изменять и удалять данные в Битрикс24./crm.lead.update— вызываемый метод REST API..json— при создании новых вебхуков параметр используется по умолчанию.?ID=42— параметры, необходимые для конкретного метода. Параметры указываются после вопросительного знака и разделяются символом &.
Пример выполнения метода обновления
Рассмотрим пример методов обновления crm.***.update. Для этих методов CRM, кроме смарт-процессов, действует общее правило: в методе передаются ID, а затем массив с изменяемыми значениями в fields.
Пример при выполнении метода обновления в адресной строке браузера: crm.***.update.json?id=1&fields[TITLE]=Тестовая%20сущность&fields[ASSIGNED_BY_ID]=1&fields[UF_CRM_1234567890]=TEST
Рассмотрим, как строить запросы REST API для выполнения в строке браузера: [метод].json?[если передаем массив, то передаем поле так:]fields[[поле]]
Параметры для разных методов могут отличаться, поэтому проверяйте описание каждого метода.
Чтобы проверить запрос, нажмите Выполнить и посмотрите результат.
Настройка прав. Можно разрешить выполнять запросы только для определенных инструментов Битрикс24. Например, сценарий Импорт контрагентов будет работать только для раздела CRM.
Локальные приложения
Локальные приложения — это приложения, которое вы создаете для своего Битрикс24. Перейдите на вкладку Готовые сценарии > Другое > Локальное приложение.
Локальные приложения. Быстрый старт
Как найти созданные вебхуки и приложения
Перейдите на вкладку Интеграции. Здесь вы увидите:
- название вебхуков и приложений,
- какие события они вызывают,
- к каким инструментам есть доступ,
- какой пользователь их создал.
Чтобы в списке вебхуков видеть только нужную информацию, нажмите Настройки (⚙️) и выберите поля. Если надо отредактировать или удалить вебхук или приложение, нажмите Меню (≡).
Как посмотреть статистику приложений и вебхуков
Откройте вкладку Статистика, здесь можно посмотреть количество запросов по каждому вебхуку и приложению. Этот инструмент поможет оценить нагрузку REST-запросов на Битрикс24.
Как оценить нагрузку REST на Битрикс24
Чтобы посмотреть статистику по конкретным приложениям и вебхукам, используйте поле Фильтр. Вы можете отфильтровать данные максимум за 14 дней.
Чтобы в статистике видеть только нужную информацию, нажмите Настройки (⚙️) и выберите поля.
- В разделе Разработчикам мы собрали инструменты для доработки возможностей Битрикс24 с помощью вебхуков и REST API.
- Для создания вебхуков можно использовать готовые сценарии. Если не нашли нужный сценарий, создайте вебхук самостоятельно.
- Создавать вебхуки может любой пользователь.
- Создавать приложения может только администратор Битрикс24.
- Найти все созданные вебхуки и приложения можно на вкладке Интеграции.
- Посмотреть статистику запросов по вебхукам и приложениям можно на вкладке Статистика.
Коротко
Рекомендуем прочитать: