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

event.bind

Регистрация нового обработчика события.

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

  • оффлайн-события недоступны, попытка установки будет порождать исключение;
  • события устанавливаются от имени текущего пользователя (см. описание параметра auth_type); явное указание auth_type, отличного от ID текущего пользователя, также будет порождать исключение;

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

Интерфейс для данного метода - BX24.callBind.

Параметры

Параметр Описание
event Имя события. Обязательный.
handler Ссылка на обработчик события. Обязательный.
auth_type Идентификатор пользователя, под которым авторизуется обработчик события. Не обязательный. По умолчанию будет использоваться авторизация пользователя, действия которого привели к срабатыванию события.
event_type Значения: online|offline. По умолчанию event_type=online, и поведение метода не меняется. Если вызывается event_type=offline, то метод работает с оффлайн событиями.
options Дополнительные настройки для регистрируемого события, при наличии.

Пример:

https://my.bitrix24.ru/rest/event.bind.json?auth=a25e86871fcebb24f4d9076caf2e6623&auth_type=0&event=OnAppUpdate&handler=http%3A%2F%2Fwww.my-domain.com%2Fhandler%2F

Ответ:

{"result":true}


© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх