Send Events to the RT Channel of the pull.application.event.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: pull

Who can execute the method: a user authorized in the application

The method pull.application.event.add sends an event to the RT channel of the application.

The method works only in the context of the application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
COMMAND^* `string`	The event command. The parameter accepts any command value as long as it adheres to the format. Allowed characters: `A-Z`, `a-z`, `0-9`, `_`, `:`, `\\|`, `.`, `-`
PARAMS `object`	Event parameters in the format: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }` where: `field_n` - the name of the event parameter `value_n` - the value of the event parameter The parameter accepts any name and value. Example: `{ "grid_id": 15, "status": "done" }`
MODULE_ID `string`	The identifier of the event module. The parameter accepts any identifier value as long as it adheres to the format. Allowed characters: `a-z`, `0-9`, `.`, `_`. If the parameter is not provided, `application` is used as the default event module identifier.
USER_ID `integer` \| `integer[]`	The user identifier or an array of user identifiers. `USER_ID` can be obtained by: using the user.get method using the user.current method for the current user A user without admin rights can only specify their own identifier. If the parameter is not provided, the event is sent to the general channel.

Code Examples

How to Use Examples in Documentation

Example of sending an event to the general channel of the application, where:

COMMAND - the event command
PARAMS - the event parameters
MODULE_ID - the identifier of the event module

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "COMMAND": "test_event",
            "PARAMS": {
              "param1": "value1"
            },
            "MODULE_ID": "application",
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/pull.application.event.add.json"

try
        {
        	const response = await $b24.callMethod(
        		'pull.application.event.add',
        		{
        			COMMAND: 'test_event',
        			PARAMS: {
        				param1: 'value1'
        			},
        			MODULE_ID: 'application'
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'pull.application.event.add',
                    [
                        'COMMAND' => 'test_event',
                        'PARAMS' => [
                            'param1' => 'value1',
                        ],
                        'MODULE_ID' => 'application',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error sending event: ' . $e->getMessage();
        }

BX24.callMethod(
            'pull.application.event.add',
            {
                COMMAND: 'test_event',
                PARAMS: {
                    param1: 'value1'
                },
                MODULE_ID: 'application'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

$result = CRest::call(
            'pull.application.event.add',
            [
                'COMMAND' => 'test_event',
                'PARAMS' => [
                    'param1' => 'value1',
                ],
                'MODULE_ID' => 'application',
            ]
        );
        
        echo '<pre>';
        print_r($result);
        echo '</pre>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1743495945,
                "finish": 1743495945.285066,
                "duration": 0.2850658893585205,
                "processing": 0.008597135543823242,
                "date_start": "2025-04-01T11:52:25+02:00",
                "date_finish": "2025-04-01T11:52:25+02:00",
                "operating_reset_at": 1743496545,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Indicator of successful event sending
time `time`	Information about the request execution time

Error Handling

HTTP Status: 403

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Get access to application config available only for application authorization."
        }

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	Description	Value
`403`	`WRONG_AUTH_TYPE`	Get access to application config available only for application authorization.	Method call not from the application authorization context
`400`	`USER_ID_ACCESS_ERROR`	Only admin can send notifications to other channels	A user without admin rights attempts to send an event to another channel
`400`	`MODULE_ID_ERROR`	Module ID format error	An incorrect type of `MODULE_ID` was provided
`400`	`COMMAND_ERROR`	Command format error	An incorrect type of `COMMAND` was provided
`400`	`PARAMS_ERROR`	Params format error	An incorrect type of `PARAMS` was provided

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	The REST API is available only on commercial plans. 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?

Get connection configuration for RT servers

Send a push notification to the application's mobile device

Send Events to the RT Channel of the pull.application.event.add

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