Документация для разработчиков

События

Интерфейс REST позволяет устанавливать свои обработчики серверных событий.

Обработчиком служит URL, который будет вызван после того, как пользователь произведет запрошенное действие на портале Битрикс24, на который установлено приложение. Поскольку запросы будут идти с серверов Битрикс, то любой URL должен быть доступен для GET/POST запросов извне.

Обработчик получает на вход следующие данные:

Поле запроса Описание
event Имя сработавшего события
data Массив данных события. Зависит от события.
auth Набор данных для авторизации. Зависит от события.

Обработчик может:

  • использовать полученные данные авторизации для выполнения запросов к REST API.
  • быть установлен только пользователем с правами администрирования портала.

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

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

Обработчик события будет вызван не сразу после срабатывания события, а через некоторое время, зависящее от нагрузки.

Список доступных событий можно получить при помощи REST-метода events.

Установка обработчика события производится при помощи REST-метода event.bind или при помощи функции BX24.callBind js-библиотеки. Получение списка зарегистрированных обработчиков событий производится при помощи REST-метода events.get

Снятие зарегистрированного обработчка события производится при помощи REST-метода event.unbind или при помощи функции BX24.callUnbind js-библиотеки.

Для доступа к каждому событию при регистрации версии приложения должно быть запрошено соответствующее событию право доступа.

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

Имена событий регистронезависимы.

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

Пример

Событие установки приложения

array(
  'event' => 'ONAPPINSTALL',
  'data' => array(
    'VERSION' => '1',
    'LANGUAGE_ID' => 'ru',
  ),
  'ts' => '1466439714',
  'auth' => array(
    'access_token' => 's6p6eclrvim6da22ft9ch94ekreb52lv',
    'expires_in' => '3600',
    'scope' => 'entity,im',
    'domain' => 'portal.bitrix24.com',
    'server_endpoint' => 'https://oauth.bitrix.info/rest/',
    'status' => 'F',
    'client_endpoint' => 'https://portal.bitrix24.ru/rest/',
    'member_id' => 'a223c6b3710f85df22e9377d6c4f7553',
    'refresh_token' => '4s386p3q0tr8dy89xvmt96234v3dljg8',
    'application_token' => '51856fefc120afa4b628cc82d3935cce',
  ),
)


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх