Получить список доступных событий events

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

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

Метод events возвращает коды событий Битрикс24. По этому списку приложение выбирает, на какие события подписаться методом event.bind. Какие события попадут в список, зависит от параметров SCOPE и FULL.

Метод работает только в контексте авторизации приложения. Через вебхук он вернет ошибку WRONG_AUTH_TYPE.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

SCOPE
string

Scope, события которого нужно получить, например crm или user. Метод вернет события только этого scope, даже если у приложения нет такого разрешения.

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

FULL
boolean

Если передать true, метод вернет все события Битрикс24 независимо от разрешений приложения.

Параметр не работает, если передан SCOPE, даже пустой

Если не передать параметры, метод вернет события из scope приложения и общие события, которые доступны любому приложению: например, ONAPPINSTALL и ONOFFLINEEVENT.

Примеры кода

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

Пример №1

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "SCOPE": "user",
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/events

Пример №2

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "FULL": true,
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/events

Пример №1

BX24.callMethod(
    "events",
    {
        "SCOPE": "user"
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

Пример №2

BX24.callMethod(
    "events",
    {
        "FULL": true
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

Пример №1

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.events(
        scope="user",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

Пример №2

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.events(
        full=True,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

Пример №1

require_once('crest.php');

$result = CRest::call(
    'events',
    [
        'SCOPE' => 'user'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

Пример №2

require_once('crest.php');

$result = CRest::call(
    'events',
    [
        'FULL' => true
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

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

HTTP-статус: 200

Ответ на первый пример — запрос с SCOPE: "user":

{
    "result": [
        "ONUSERADD"
    ],
    "time": {
        "start": 1790304784,
        "finish": 1790304784.638336,
        "duration": 0.6383359432220459,
        "processing": 0,
        "date_start": "2026-09-25T05:53:04+03:00",
        "date_finish": "2026-09-25T05:53:04+03:00",
        "operating_reset_at": 1790305384,
        "operating": 0
    }
}

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

Название
тип

Описание

result
array

Массив строк — символьных кодов событий в верхнем регистре, например ONCRMDEALADD. Код передают в параметре event метода event.bind.

Какие коды попадут в массив, зависит от параметров SCOPE и FULL

time
time

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

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

HTTP-статус: 403

{
    "error": "WRONG_AUTH_TYPE",
    "error_description": "Current authorization type is denied for this method"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

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

Описание

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method

Метод вызван не из приложения, например через вебхук

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Обзор методов и событий
Следующая
Зарегистрировать обработчик