метод REST

event.bind

Зарегистрировать новый обработчик события

Кто может выполнять: любой пользователь

Описание

Метод event.bind регистрирует новый обработчик события.

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

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

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

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

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

События не будут отправляться в приложение, пока установка не завершена. Проверьте установку приложения

Параметры

event string обязательный

Имя события

handler string обязательный

Ссылка на обработчик события

auth_type integer необязательный

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

event_type string необязательный

Значения: ``online|offline`. По умолчанию event_type=online, и поведение метода не меняется. Если вызывается event_type=offline`, то метод работает с офлайн-событиями

auth_connector string необязательный

Ключ источника. Параметр предназначен для офлайн-событий. Позволяет исключать ложные срабатывания событий

options object необязательный

Дополнительные настройки регистрируемого события. Набор полей зависит от события.

Для события ONOFFLINEEVENT поддерживается параметр minTimeout — минимальный интервал между уведомлениями в секундах. По умолчанию 1. Подробнее в статье onOfflineEvent

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "event": "ONCRMLEADADD",
    "handler": "https://www.my-domain.ru/handler/",
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/event.bind

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1721296536.908506,
        "finish": 1721296537.007365,
        "duration": 0.09885907173156738,
        "processing": 0.03251290321350098,
        "date_start": "2024-07-18T11:55:36+02:00",
        "date_finish": "2024-07-18T11:55:37+02:00",
        "operating": 0
    }
}

Возвращаемые данные

result boolean

Успешность выполнения

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error":"ERROR_EVENT_NOT_FOUND",
    "error_description":"Event not found"
}
Код Описание Значение
400 ERROR_EVENT_NOT_FOUND Event not found
403 ACCESS_DENIED Access denied! Offline events binding requires administrator access rights
403 ACCESS_DENIED Access denied! Event binding with AUTH_TYPE requires administrator access rights

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.