Зарегистрировать новый обработчик события 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
string

Дополнительные настройки для регистрируемого события, при наличии

Примеры кода

Как использовать примеры в документации

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
        
BX24.callBind(
            'ONCRMLEADADD',
            'https://www.my-domain.ru/handler/',
            15,
            (result) => console.log(result)
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'event.bind',
            [
                'event' => 'ONCRMLEADADD',
                'handler' => 'https://www.my-domain.ru/handler/',
                'auth_type' => 15
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

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"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Cообщение об ошибке

Описание

ERROR_EVENT_NOT_FOUND

Event not found

Неверно указано событие

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

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

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

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

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить список доступных событий
Следующая
Как проверить свой обработчик