Get a list of available events

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

cURL (OAuth)

PHP

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

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Event Handler

Get a list of available events

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Code Examples

Response Handling

Returned Data

Error Handling

Statuses and System Error Codes

Continue Learning