Прочитайте готовые ответы
Новые статьи
Поддержка Битрикс24
Регистрация и вход
Тарифы и оплата
Задачи и проекты
Мессенджер
Группы
Календарь
CRM + Интернет-магазин
Диск
Сайты
База знаний
Интернет-магазин (beta)
Складской учет
Почта
CRM
CoPilot — AI в Битрикс24
Битрикс24 КЭДО
Маркетинг
Сквозная аналитика
Центр продаж (beta)
CRM-аналитика (beta)
BI Конструктор
Автоматизация
CRM.Оплата и Доставка
Интеграция 1С и Битрикс24
Компания
Бизнес-процессы
Приложения
Контакт-центр
Моя страница
Телефония
Настройки
Мой тариф
Энтерпрайз
Enterprise HRM
Мобильное приложение
Десктоп-приложение
Общие вопросы
Готовые решения для бизнеса
Битрикс24 в коробке
1С-Битрикс24: Интернет-магазин + CRM
Изменения в статьях (архив)

Поддержка24

Разработчикам: как создать вебхуки и приложения для Битрикс24

В разделе Разработчикам мы собрали инструменты для доработки возможностей Битрикс24. Здесь вы сможете:

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

Как создать вебхук

На вкладке Готовые сценарии есть примеры популярных сценариев для создания вебхуков: создать чат-бота для информирования сотрудников или добавить в карточку звонка скрипт продаж. Если вы не нашли нужный сценарий, можно создать свой вебхук. Создавать вебхуки может любой пользователь.

Выберите сценарий и перейдите к настройкам.

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

Никому не передавайте секретный код вебхука и не указывайте его в коде страницы или скрипта. Если посторонние люди увидят этот код, они смогут получить доступ к данным вашего Битрикс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. Перейдите на вкладку Готовые сценарии > Другое > Локальное приложение.
Локальные приложения. Быстрый старт

Создавать приложения может только администратор Битрикс24.

Как найти созданные вебхуки и приложения

Перейдите на вкладку Интеграции. Здесь вы увидите:

  • название вебхуков и приложений,
  • какие события они вызывают,
  • к каким инструментам есть доступ,
  • какой пользователь их создал.
У администратора Битрикс24 есть доступ ко всем созданным вебхукам и приложениям. У обычного пользователя только к тем, которые он создал.

Чтобы в списке вебхуков видеть только нужную информацию, нажмите Настройки (⚙️) и выберите поля. Если надо отредактировать или удалить вебхук или приложение, нажмите Меню (≡).


Как посмотреть статистику приложений и вебхуков

Откройте вкладку Статистика, здесь можно посмотреть количество запросов по каждому вебхуку и приложению. Этот инструмент поможет оценить нагрузку REST-запросов на Битрикс24.
Как оценить нагрузку REST на Битрикс24

Инструмент Статистика доступен только администратору Битрикс24.

Чтобы посмотреть статистику по конкретным приложениям и вебхукам, используйте поле Фильтр. Вы можете отфильтровать данные максимум за 14 дней.

Чтобы в статистике видеть только нужную информацию, нажмите Настройки (⚙️) и выберите поля.


    Коротко

  • В разделе Разработчикам мы собрали инструменты для доработки возможностей Битрикс24 с помощью вебхуков и REST API.
  • Для создания вебхуков можно использовать готовые сценарии. Если не нашли нужный сценарий, создайте вебхук самостоятельно.
  • Создавать вебхуки может любой пользователь.
  • Создавать приложения может только администратор Битрикс24.
  • Найти все созданные вебхуки и приложения можно на вкладке Интеграции.
  • Посмотреть статистику запросов по вебхукам и приложениям можно на вкладке Статистика.

Рекомендуем прочитать:


Спасибо, помогло!
Спасибо :)
Не помогло
Очень жаль :(
Помощь интегратора
Это не то, что я ищу
Написано очень сложно и непонятно
Есть устаревшая информация
Слишком коротко, мне не хватает информации
Мне не нравится, как это работает