Send Push Notification to Mobile Device via 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:
pullWho can execute the method: administrator
The method pull.application.push.add sends a push notification to a mobile device within the application.
This method works only in the context of the application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the user or an array of user identifiers to whom the push notification is sent.
|
|
|
TEXT* |
Text of the push notification |
|
AVATAR |
URL of the image for the push notification |
Code Examples
How to Use Examples in Documentation
Example of sending a push notification to application users, where:
USER_ID— user identifier or an array of user identifiersTEXT— text of the push notificationAVATAR— URL of the image for the push notification
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"
try
{
const response = await $b24.callMethod(
'pull.application.push.add',
{
USER_ID: [1, 2, 3],
TEXT: 'Hello, world!',
AVATAR: 'https://example.com/images/avatar.png'
}
);
const result = response.getData().result;
console.info(result);
}
catch (error)
{
console.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+03:00",
"date_finish": "2025-04-01T11:52:25+03:00",
"operating_reset_at": 1743496545,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Indicator of successful method execution |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 403
{
"error": "WRONG_AUTH_TYPE",
"error_description": "Send push notifications available only for application authorization."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Send push notifications available only for application authorization. |
Method call not in the context of application authorization |
|
|
|
You do not have access to send push notifications |
User without administrator rights attempts to send a push notification |
|
|
|
Text can't be empty |
|
|
|
|
For send push-notification application name can't be empty |
Application name is not filled in |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |