Send an Event to the Application Channel 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: any user authorized in the application. Only a Bitrix24 administrator can send an event to another user's channel

The method pull.application.event.add sends an event to the application channel. The event is received by the built-in client in the browser or by a custom client connected to the channel. This is how the interface of an open application is updated; to notify the user outside the Bitrix24 interface, a different method is needed — pull.application.push.add.

An event is retained in the Push&Pull queue for 24 hours, so it can be taken from the history after connecting late — how to do that is described in the Custom Push&Pull Client article. Do not confuse this period with the 12 hours: that is how long the channel identifier lives, and after it is reissued the history is read on by mid or by the tag and time pair.

The channel identifiers and the server addresses are retrieved by the client beforehand with the pull.application.config.get method. The MODULE_ID and COMMAND values from the request have to match what the client has subscribed to, otherwise the handler will not receive the event.

The method works only in the context of an application. The request is executed with the application OAuth token and the pull scope, and a webhook does not create such a context.

Method Parameters

Required parameters are marked with *

Name `type`	Description
COMMAND^* `string`	The event command. Allowed characters: `A-Z`, `a-z`, `0-9`, `_`, `:`, `\|`, `.`, `-` The client uses the command to distinguish event types and decide what to update in the interface
PARAMS `object`	The 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 You set the field names and values yourself. If the parameter is not passed, the client receives the command with an empty `params`. The size of the message that Bitrix24 sends to the Push&Pull server is limited to 1 MB. In the self-hosted version the administrator can change the limit with the `limit_max_payload` setting of the `pull` module. Example: `{ "grid_id": 15, "status": "done" }`
MODULE_ID `string`	The identifier of the event module. Allowed characters: `a-z`, `0-9`, `.`, `_` `application` is used by default
USER_ID `integer` \| `string` \| `integer[]`	A user identifier or an array of user identifiers. `USER_ID` can be retrieved: with the user.get method with the user.current method for the current user A Bitrix24 administrator can specify any users and pass an array of identifiers. A user without administrator permissions can specify only their own identifier, and only as a string — `"USER_ID": "577"`. Bitrix24 compares the value with the identifier of the current user strictly by type, so the method rejects both the number `577` and the array `["577"]` with the `USER_ID_ACCESS_ERROR` error. If the parameter is not passed, the event is sent to the common `shared` channel, and with the parameter it is sent to the `private` personal channel of the specified user. The client has to be subscribed to the required channel — Subscribing to Events

Code Examples

How to Use Examples in Documentation

An example of sending an event to the common channel of an application, where:

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

cURL (OAuth)

JS (TS)

JS (UMD)

Python

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"

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'pull.application.event.add',
            params: {
              COMMAND: 'test_event',
              PARAMS: {
                param1: 'value1',
              },
              MODULE_ID: 'application',
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Event accepted:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function sendApplicationEvent() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'pull.application.event.add',
                params: {
                  COMMAND: 'test_event',
                  PARAMS: {
                    param1: 'value1',
                  },
                  MODULE_ID: 'application',
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Event accepted:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', sendApplicationEvent)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        # The method is called directly: in the typed wrapper client.pull.application.event.add
        # the params argument accepts a list rather than an object, so PARAMS cannot be passed through it
        try:
            bitrix_response = client.call(
                "pull.application.event.add",
                {
                    "COMMAND": "test_event",
                    "PARAMS": {
                        "param1": "value1",
                    },
                    "MODULE_ID": "application",
                },
            ).response
            print(bitrix_response.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}")

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>';

The examples send the event to the common channel. To send it to a personal channel, add USER_ID to the request:

{
            "COMMAND": "test_event",
            "PARAMS": {
                "param1": "value1"
            },
            "MODULE_ID": "application",
            "USER_ID": "577"
        }

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`	The indicator that the event has been accepted for sending. The method returns `true` even if the event did not reach the channel — for example, when the Push&Pull server did not accept the event because of its size
time `time`	Information about the request execution time. The composition of the fields — Time Object

Error Handling

HTTP Status: 403

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

HTTP Status: 400

{
            "error": "COMMAND_ERROR",
            "error_description": "Command format error"
        }

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.	The method was called outside the context of an application, for example, through a webhook. The error text is the same as the text of the same error of the pull.application.config.get method — tell them apart by the name of the method called
`400`	`USER_ID_ACCESS_ERROR`	Only admin can send notifications to other channels	A user without administrator permissions is trying to send an event to someone else's channel, or is passing their own `USER_ID` as a number or an array instead of a string
`400`	`MODULE_ID_ERROR`	Module ID format error	The `MODULE_ID` parameter contains disallowed characters
`400`	`COMMAND_ERROR`	Command format error	The `COMMAND` parameter is not passed, is empty, or contains disallowed characters
`400`	`PARAMS_ERROR`	Params format error	The `PARAMS` parameter is not passed as an object

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 the Connection Configuration for Push&Pull Servers

Send a Push Notification to the Application Users

Send an Event to the Application Channel 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