Get a List of Available Events

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Who can execute the method: any user

Retrieves Bitrix24 event codes. The application uses this list to choose which events to subscribe to with the event.bind method. The events included in the list depend on the SCOPE and FULL parameters.

The method works only in the context of authorizing the application. When called through a webhook, it returns the WRONG_AUTH_TYPE error.

Method Parameters

Required parameters are marked with *

Name
type

Description

SCOPE
string

Scope whose events you need to retrieve, for example crm or user. The method returns events of this scope only, even if the application does not have this permission.

If you pass an empty string, the method returns only the common application events. For an unknown scope, the method returns an empty array without an error

FULL
boolean

If you pass true, the method returns all Bitrix24 events regardless of the application's permissions.

The parameter has no effect if SCOPE is passed, even an empty one

If no parameters are passed, the method returns events from the application's scope and common events available to any application: for example, ONAPPINSTALL and ONOFFLINEEVENT.

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

BX24.js

Python

PHP CRest

Example №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

Example №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

Example №1

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

Example №2

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

Example №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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

Example №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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

Example №1

require_once('crest.php');
        
        $result = CRest::call(
            'events',
            [
                'SCOPE' => 'user'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Example №2

require_once('crest.php');
        
        $result = CRest::call(
            'events',
            [
                'FULL' => true
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

Response to the first example — a request with 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
            }
        }

Returned Data

Name
type

Description

result
array

An array of strings — symbolic event codes in uppercase, for example ONCRMDEALADD. The code is passed in the event parameter of the event.bind method.

The codes included in the array depend on the SCOPE and FULL parameters

time
time

Information about the request execution time

Error Handling

HTTP status: 403

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

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status	Code	Error message	Description
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method	The method was called outside an application, for example, through a webhook

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Overview of Methods and Events

Get a List of Available Events

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning