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

The events method returns a comprehensive list of available events.

The method works only in the context of authorizing the application.

Method Parameters

Required parameters are marked with *

Name
type

Description

SCOPE
string

The method will return events belonging to the specified permission

FULL
boolean

The method will return the complete list of events. This parameter will be ignored if the SCOPE parameter is provided

Code Examples

How to Use Examples in Documentation

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

{
            "result":[
                "ONAPPUNINSTALL",
                "ONAPPINSTALL",
                "ONAPPUPDATE",
                "ONAPPPAYMENT",
                "ONAPPTEST",
                "ONAPPMETHODCONFIRM",
                "ONOFFLINEEVENT",
                "ONUSERADD",
                "ONCRMINVOICEADD",
                "ONCRMINVOICEUPDATE",
                "ONCRMINVOICEDELETE",
                "ONCRMINVOICESETSTATUS",
                "ONCRMLEADADD",
                "ONCRMLEADUPDATE",
                "ONCRMLEADDELETE",
                "ONCRMLEADUSERFIELDADD",
                "ONCRMLEADUSERFIELDUPDATE",
                "ONCRMLEADUSERFIELDDELETE",
                "ONCRMLEADUSERFIELDSETENUMVALUES",
                "ONCRMDEALADD",
                "ONCRMDEALUPDATE",
                "ONCRMDEALDELETE",
                "ONCRMDEALMOVETOCATEGORY",
                "ONCRMDEALUSERFIELDADD",
                "ONCRMDEALUSERFIELDUPDATE",
                "ONCRMDEALUSERFIELDDELETE",
                "ONCRMDEALUSERFIELDSETENUMVALUES",
                "ONCRMCOMPANYADD",
                "ONCRMCOMPANYUPDATE",
                "ONCRMCOMPANYDELETE",
                "ONCRMCOMPANYUSERFIELDADD",
                "ONCRMCOMPANYUSERFIELDUPDATE",
                "ONCRMCOMPANYUSERFIELDDELETE",
                "ONCRMCOMPANYUSERFIELDSETENUMVALUES",
                "ONCRMCONTACTADD",
                "ONCRMCONTACTUPDATE",
                "ONCRMCONTACTDELETE",
                "ONCRMCONTACTUSERFIELDADD",
                "ONCRMCONTACTUSERFIELDUPDATE",
                "ONCRMCONTACTUSERFIELDDELETE",
                "ONCRMCONTACTUSERFIELDSETENUMVALUES",
                "ONCRMQUOTEADD",
                "ONCRMQUOTEUPDATE",
                "ONCRMQUOTEDELETE",
                "ONCRMQUOTEUSERFIELDADD",
                "ONCRMQUOTEUSERFIELDUPDATE",
                "ONCRMQUOTEUSERFIELDDELETE",
                "ONCRMQUOTEUSERFIELDSETENUMVALUES",
                "ONCRMINVOICEUSERFIELDADD",
                "ONCRMINVOICEUSERFIELDUPDATE",
                "ONCRMINVOICEUSERFIELDDELETE",
                "ONCRMINVOICEUSERFIELDSETENUMVALUES",
                "ONCRMCURRENCYADD",
                "ONCRMCURRENCYUPDATE",
                "ONCRMCURRENCYDELETE",
                "ONCRMPRODUCTADD",
                "ONCRMPRODUCTUPDATE",
                "ONCRMPRODUCTDELETE",
                "ONCRMPRODUCTPROPERTYADD",
                "ONCRMPRODUCTPROPERTYUPDATE",
                "ONCRMPRODUCTPROPERTYDELETE",
                "ONCRMPRODUCTSECTIONADD",
                "ONCRMPRODUCTSECTIONUPDATE",
                "ONCRMPRODUCTSECTIONDELETE",
                "ONCRMACTIVITYADD",
                "ONCRMACTIVITYUPDATE",
                "ONCRMACTIVITYDELETE",
                "ONCRMREQUISITEADD",
                "ONCRMREQUISITEUPDATE",
                "ONCRMREQUISITEDELETE",
                "ONCRMREQUISITEUSERFIELDADD",
                "ONCRMREQUISITEUSERFIELDUPDATE",
                "ONCRMREQUISITEUSERFIELDDELETE",
                "ONCRMREQUISITEUSERFIELDSETENUMVALUES",
                "ONCRMBANKDETAILADD",
                "ONCRMBANKDETAILUPDATE",
                "ONCRMBANKDETAILDELETE",
                "ONCRMADDRESSREGISTER",
                "ONCRMADDRESSUNREGISTER",
                "ONCRMMEASUREADD",
                "ONCRMMEASUREUPDATE",
                "ONCRMMEASUREDELETE",
                "ONCRMDEALRECURRINGADD",
                "ONCRMDEALRECURRINGUPDATE",
                "ONCRMDEALRECURRINGDELETE",
                "ONCRMDEALRECURRINGEXPOSE",
                "ONCRMINVOICERECURRINGADD",
                "ONCRMINVOICERECURRINGUPDATE",
                "ONCRMINVOICERECURRINGDELETE",
                "ONCRMINVOICERECURRINGEXPOSE",
                "ONCRMTIMELINECOMMENTADD",
                "ONCRMTIMELINECOMMENTUPDATE",
                "ONCRMTIMELINECOMMENTDELETE",
                "ONCRMDYNAMICITEMADD",
                "ONCRMDYNAMICITEMUPDATE",
                "ONCRMDYNAMICITEMDELETE",
                "ONCRMDYNAMICITEMADD_147",
                "ONCRMDYNAMICITEMUPDATE_147",
                "ONCRMDYNAMICITEMDELETE_147",
                "ONCRMTYPEADD",
                "ONCRMTYPEUPDATE",
                "ONCRMTYPEDELETE",
                "ONCRMDOCUMENTGENERATORDOCUMENTADD",
                "ONCRMDOCUMENTGENERATORDOCUMENTUPDATE",
                "ONCRMDOCUMENTGENERATORDOCUMENTDELETE",
                "ONTASKADD",
                "ONTASKUPDATE",
                "ONTASKDELETE",
                "ONTASKCOMMENTADD",
                "ONTASKCOMMENTUPDATE",
                "ONTASKCOMMENTDELETE"
            ]
        }

Returned Data

Name
type

Description

result
object

Root element of the response

Error Handling

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

Previous
Overview of Methods and Events
Next
Register a Handler