Interacting with Notification Buttons im.notify.confirm
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
imWho can execute the method: any user
The method im.notify.confirm clicks a button in a notification of the current user and deletes that notification.
Notifications with buttons are created by Bitrix24 modules, for example meeting invitations in the calendar. The im.notify.personal.add and im.notify.system.add methods do not create such notifications
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
NOTIFY_ID* |
Identifier of the notification with buttons. You can retrieve the identifier using the im.notify.get method; for such notifications, the Instead of |
|
NOTIFY_VALUE* |
Value of the selected button. The values are set by the module that sent the notification. For example, a notification with the "Accept" and "Decline" buttons has the values The method treats the string |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NOTIFY_ID":288,"NOTIFY_VALUE":"Y"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.notify.confirm
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NOTIFY_ID":288,"NOTIFY_VALUE":"Y","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.notify.confirm
// 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
// Shape of the payload returned in result (match the "response handling" section of the page)
type NotifyConfirmResult = {
result_message: string[] | false
}
try {
const response = await $b24.actions.v2.call.make<NotifyConfirmResult>({
method: 'im.notify.confirm',
params: {
NOTIFY_ID: 288,
NOTIFY_VALUE: 'Y',
},
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(result.result_message)
}
} 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 confirmNotification() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.notify.confirm',
params: {
NOTIFY_ID: 288,
NOTIFY_VALUE: 'Y',
},
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(result.result_message)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', confirmNotification)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.notify.confirm(
notify_id=288,
notify_value=True,
).response
result = bitrix_response.result
print(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(
'im.notify.confirm',
[
'NOTIFY_ID' => 288,
'NOTIFY_VALUE' => 'Y',
]
);
$result = $response->getResponseData()->getResult();
print_r($result);
} catch (Throwable $exception) {
echo $exception->getMessage();
}
BX24.callMethod(
'im.notify.confirm',
{
NOTIFY_ID: 288,
NOTIFY_VALUE: 'Y',
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.notify.confirm',
[
'NOTIFY_ID' => 288,
'NOTIFY_VALUE' => 'Y',
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
var_dump($result['result']);
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "im.notify.confirm", b24.Params{
"NOTIFY_ID": 288,
"NOTIFY_VALUE": "Y",
})
if err != nil {
return fmt.Errorf("im.notify.confirm: %w", err)
}
// The method wraps the response in an object with the "result_message" key.
raw, ok := b24.Unwrap(res.Result, "result_message")
if !ok {
return fmt.Errorf("no result_message key in the response")
}
fmt.Printf("%s\n", raw)
Response Handling
HTTP Status: 200
{
"result": {
"result_message": [
"Your selection: \"Accept\""
]
},
"time": {
"start": 1794317487,
"finish": 1794317487.750427,
"duration": 0.7504270076751709,
"processing": 0,
"date_start": "2026-11-10T16:31:27+01:00",
"date_finish": "2026-11-10T16:31:27+01:00",
"operating_reset_at": 1794318060,
"operating": 0
}
}
If the notification is not found among the current user's notifications or has no buttons, the method returns HTTP status 200 and false in the result_message field:
{
"result": {
"result_message": false
},
"time": {
"start": 1794317487,
"finish": 1794317487.750427,
"duration": 0.7504270076751709,
"processing": 0,
"date_start": "2026-11-10T16:31:27+01:00",
"date_finish": "2026-11-10T16:31:27+01:00",
"operating_reset_at": 1794318060,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing the result of the button press (detailed description) |
|
time |
Information about the request execution time |
Result Object
|
Name |
Description |
|
Result of the button press:
After the button is pressed, the notification is deleted, even if the array is empty |
Error Handling
HTTP Status: 400
{
"error": "NOTIFY_VALUE_ERROR",
"error_description": "Notification Value can't be empty"
}
|
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 |
|
|
|
Notification ID can't be empty |
The |
|
|
|
Notification Value can't be empty |
The |
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 |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. 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 |
Continue Learning
- Send Notification im.notify
- Send Personal Notification im.notify.personal.add
- Send System Notification im.notify.system.add
- Get Notifications im.notify.get
- Get Notification Type Schema im.notify.schema.get
- Read the list of notifications im.notify.read.list
- Read or Mark Notification as Unread im.notify.read
- Read All Notifications im.notify.read.all
- Responding to Notifications with Quick Response im.notify.answer
- Delete Notification im.notify.delete
- Searching Notification History im.notify.history.search