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

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, то метод работает с офлайн событиями.
auth_connector Ключ источника. Параметр предназначен для офлайн событий. Позволяет исключать ложные срабатывания событий.
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}


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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
0
Михаил Капустин
Сообщение не промодерировано, возможны ошибки и неточности.
При бинде оффлайн событий через батч нужно чтобы auth_connector был глобальный (вне cmd). Через библиотеку js как я понял этого не сделать, поэтому callMethod в цикле, либо писать свой вызов батча.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх