Send a Push Notification to the Application Users pull.application.push.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: only a Bitrix24 administrator

The method pull.application.push.add sends a push notification to the application users. The notification arrives in the Bitrix24 mobile app on behalf of your application, so the application has to have its name filled in.

A push notification does not go to a Push&Pull channel: it is delivered by the mobile app, and the recipient will see the notification only if the app is installed. To update the interface of an open application, use pull.application.event.add — that method puts an event into the channel, where the client reads it from.

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
USER_ID `integer` \| `string` \| `integer[]`	A user identifier or an array of user identifiers the push notification is sent to. Always pass the parameter: there is no validation on the REST side, and without `USER_ID` the method returns a successful response but no notification goes out. The method parses a string as JSON, so `"577"` and `"[1, 2, 3]"` are accepted as well. `USER_ID` can be retrieved: with the user.get method with the user.current method for the current user The method does not limit the number of recipients and discards duplicate identifiers
TEXT^* `string`	The text of the push notification. The size of a push notification is limited to 4 KB. Bitrix24 truncates a longer text. The method returns an error if `TEXT` is not passed, is empty, or equals `0`
AVATAR `string`	The absolute URL of an image for the push notification. The image is downloaded by the Bitrix24 mobile app when it receives the notification. There is no check that the URL is reachable: if the image fails to load, the notification arrives without it and the method returns a successful response. Bitrix24 parses the value as a URL and reassembles it, so a string that could not be parsed will not reach the device

Code Examples

How to Use Examples in Documentation

An example of sending a push notification to the application users, where:

USER_ID — a user identifier or an array of user identifiers
TEXT — the text of the push notification
AVATAR — the URL of an image for the push notification

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "USER_ID": [1, 2, 3],
            "TEXT": "Hello, world!",
            "AVATAR": "https://example.com/images/avatar.png",
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/pull.application.push.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.push.add',
            params: {
              USER_ID: [1, 2, 3],
              TEXT: 'Hello, world!',
              AVATAR: 'https://example.com/images/avatar.png',
            },
            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('Push 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 sendApplicationPush() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'pull.application.push.add',
                params: {
                  USER_ID: [1, 2, 3],
                  TEXT: 'Hello, world!',
                  AVATAR: 'https://example.com/images/avatar.png',
                },
                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('Push accepted:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', sendApplicationPush)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.pull.application.push.add(
                [1, 2, 3],
                text="Hello, world!",
                avatar="https://example.com/images/avatar.png",
            ).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.push.add',
                    [
                        'USER_ID' => [1, 2, 3],
                        'TEXT' => 'Hello, world!',
                        'AVATAR' => 'https://example.com/images/avatar.png',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error sending push notification: ' . $e->getMessage();
        }

BX24.callMethod(
            'pull.application.push.add',
            {
                USER_ID: [1, 2, 3],
                TEXT: 'Hello, world!',
                AVATAR: 'https://example.com/images/avatar.png'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

$result = CRest::call(
            'pull.application.push.add',
            [
                'USER_ID' => [1, 2, 3],
                'TEXT' => 'Hello, world!',
                'AVATAR' => 'https://example.com/images/avatar.png',
            ]
        );
        
        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

The indicator that the notification has been accepted for sending. The method returns true regardless of whether the notification reached the device.

There is no other payload in the response: the method does not return a notification identifier, and the delivery status cannot be learned from the response

time
time

Information about the request execution time. The composition of the fields — Time Object

Why the Notification Did Not Arrive

If the notification did not arrive, check the delivery conditions:

at least one positive identifier is left in USER_ID: the method discards zeros and negative values
the Bitrix24 mobile app is installed on the recipient's device and they are signed in to it
the application has its name filled in for the current language, otherwise the method would have returned EMPTY_APP_NAME
push notifications are enabled in Bitrix24 itself

Error Handling

HTTP Status: 403

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Send push notifications available only for application authorization."
        }

HTTP Status: 400

{
            "error": "ACCESS_ERROR",
            "error_description": "You do not have access to send push notifications"
        }

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`	Send push notifications available only for application authorization.	The method was called outside the context of an application, for example, through a webhook
`400`	`ACCESS_ERROR`	You do not have access to send push notifications	A user without administrator permissions is trying to send a push notification
`400`	`TEXT_ERROR`	Text can't be empty	The `TEXT` parameter is not passed, is empty, or equals `0`
`400`	`EMPTY_APP_NAME`	For send push-notification application name can't be empty	The application has no name filled in. A name in the default language does not clear the error — Bitrix24 checks only the name for the current language

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?

Send an Event to the Application Channel

Performance Recommendations

Send a Push Notification to the Application Users pull.application.push.add

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Why the Notification Did Not ArriveWhy the Notification Did Not Arrive

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning