Send Notification im.notify

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: im

Who can execute the method: any user

The im.notify method sends a notification to a user.

The method cannot be called with session authorization — it returns the WRONG_AUTH_TYPE error. Call it via a webhook or with an application token.

Method Parameters

Required parameters are marked with *

Name
Type

Description

USER_ID*
integer

The identifier of the user receiving the notification. The recipient must be an active Bitrix24 user: if the user is not found or is inactive, the method returns result: false.

You can retrieve the user ID using the user.get, user.search, or im.user.get methods.

TYPE
string

The type of notification.

Allowed values:

Default value — USER. The method also replaces any other value with USER

MESSAGE*
string

The text of the notification. The method trims whitespace from the ends of the string; a string consisting only of spaces causes the MESSAGE_EMPTY error. Supports BB codes — for details, see Message Formatting.

For TYPE: SYSTEM called from an application, the method adds the application name as the first line of the text

MESSAGE_OUT
string

The text of the notification for external channels, such as email. For TYPE: SYSTEM called from an application, the method adds the application name as the first line of the text

TAG
string

The notification tag. If the recipient already has a notification from this application with the same tag, the previous notification is deleted.

The tag is retained only when the method is called from an application: the method appends the application key to it, so tags of different applications do not overlap. When the method is called via a webhook, the parameter is ignored

SUB_TAG
string

An additional notification tag without uniqueness checks. Notifications can be deleted by the TAG and SUB_TAG tags using the im.notify.delete method.

The tag is retained only when the method is called from an application. When the method is called via a webhook, the parameter is ignored

ATTACH
array
object
string

A notification attachment: an array of blocks, an object with the BLOCKS key, or a JSON string. The attachment size in JSON must be less than 60,000 characters. The block format is described in the Attachments section

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"USER_ID":5,"TYPE":"SYSTEM","MESSAGE":"Invoice [B]#42[/B] has been paid","MESSAGE_OUT":"Invoice #42 has been paid","ATTACH":[{"MESSAGE":"Amount: 15,000 EUR"},{"LINK":{"NAME":"Open invoice","LINK":"https://example.com/invoice/42"}}]}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.notify
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"USER_ID":5,"TYPE":"SYSTEM","MESSAGE":"Invoice [B]#42[/B] has been paid","MESSAGE_OUT":"Invoice #42 has been paid","ATTACH":[{"MESSAGE":"Amount: 15,000 EUR"},{"LINK":{"NAME":"Open invoice","LINK":"https://example.com/invoice/42"}}],"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.notify
        
// 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<number | false>({
            method: 'im.notify',
            params: {
              USER_ID: 5,
              TYPE: 'SYSTEM',
              MESSAGE: 'Invoice [B]#42[/B] has been paid',
              MESSAGE_OUT: 'Invoice #42 has been paid',
              ATTACH: [
                { MESSAGE: 'Amount: 15,000 EUR' },
                { LINK: { NAME: 'Open invoice', LINK: 'https://example.com/invoice/42' } },
              ],
            },
            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('Notification ID:', 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 sendNotification() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'im.notify',
                params: {
                  USER_ID: 5,
                  TYPE: 'SYSTEM',
                  MESSAGE: 'Invoice [B]#42[/B] has been paid',
                  MESSAGE_OUT: 'Invoice #42 has been paid',
                  ATTACH: [
                    { MESSAGE: 'Amount: 15,000 EUR' },
                    { LINK: { NAME: 'Open invoice', LINK: 'https://example.com/invoice/42' } },
                  ],
                },
                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('Notification ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', sendNotification)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.im.notify(
                user_id=5,
                type="SYSTEM",
                message="Invoice [B]#42[/B] has been paid",
                message_out="Invoice #42 has been paid",
                attach=[
                    {"MESSAGE": "Amount: 15,000 EUR"},
                    {"LINK": {"NAME": "Open invoice", "LINK": "https://example.com/invoice/42"}},
                ],
            ).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',
                [
                    'USER_ID' => 5,
                    'TYPE' => 'SYSTEM',
                    'MESSAGE' => 'Invoice [B]#42[/B] has been paid',
                    'MESSAGE_OUT' => 'Invoice #42 has been paid',
                    'ATTACH' => [
                        ['MESSAGE' => 'Amount: 15,000 EUR'],
                        ['LINK' => ['NAME' => 'Open invoice', 'LINK' => 'https://example.com/invoice/42']],
                    ],
                ]
            );
        
            $result = $response->getResponseData()->getResult();
        
            print_r($result);
        } catch (Throwable $exception) {
            echo $exception->getMessage();
        }
        
BX24.callMethod(
            'im.notify',
            {
                USER_ID: 5,
                TYPE: 'SYSTEM',
                MESSAGE: 'Invoice [B]#42[/B] has been paid',
                MESSAGE_OUT: 'Invoice #42 has been paid',
                ATTACH: [
                    { MESSAGE: 'Amount: 15,000 EUR' },
                    { LINK: { NAME: 'Open invoice', LINK: 'https://example.com/invoice/42' } },
                ],
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'im.notify',
            [
                'USER_ID' => 5,
                'TYPE' => 'SYSTEM',
                'MESSAGE' => 'Invoice [B]#42[/B] has been paid',
                'MESSAGE_OUT' => 'Invoice #42 has been paid',
                'ATTACH' => [
                    ['MESSAGE' => 'Amount: 15,000 EUR'],
                    ['LINK' => ['NAME' => 'Open invoice', 'LINK' => 'https://example.com/invoice/42']],
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } elseif ($result['result'] === false) {
            echo 'Notification not sent';
        } else {
            echo 'Notification ID: ' . $result['result'];
        }
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "im.notify", b24.Params{
        	"USER_ID":     5,
        	"TYPE":        "SYSTEM",
        	"MESSAGE":     "Invoice [B]#42[/B] has been paid",
        	"MESSAGE_OUT": "Invoice #42 has been paid",
        	"ATTACH": []map[string]any{
        		{"MESSAGE": "Amount: 15,000 EUR"},
        		{"LINK": map[string]any{"NAME": "Open invoice", "LINK": "https://example.com/invoice/42"}},
        	},
        })
        if err != nil {
        	return fmt.Errorf("im.notify: %w", err)
        }
        
        // result is the notification ID, or false if the notification was not created
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("notification not created: %s", res.Result)
        }
        fmt.Println("ID:", newID)
        

Response Handling

HTTP Status: 200

{
            "result": 44003,
            "time": {
                "start": 1794317396,
                "finish": 1794317396.101083,
                "duration": 0.10108304023742676,
                "processing": 0,
                "date_start": "2026-11-10T16:29:56+01:00",
                "date_finish": "2026-11-10T16:29:56+01:00",
                "operating_reset_at": 1794317940,
                "operating": 0
            }
        }
        

If the recipient is not found or is inactive, the method returns HTTP status 200 and false:

{
            "result": false,
            "time": {
                "start": 1794317624,
                "finish": 1794317624.580945,
                "duration": 0.5809450149536133,
                "processing": 0,
                "date_start": "2026-11-10T16:33:44+01:00",
                "date_finish": "2026-11-10T16:33:44+01:00",
                "operating_reset_at": 1794318180,
                "operating": 0
            }
        }
        

Returned Data

Name
Type

Description

result
integer
boolean

The identifier of the created notification. Pass it in ID of the im.notify.delete method to delete the notification.

The false value means that the notification was not created: the recipient is not found or is inactive

time
time

Information about the request execution time.

Error Handling

HTTP Status: 400, 403

{
            "error": "USER_ID_EMPTY",
            "error_description": "User ID can't be empty"
        }
        

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

Access for this method not allowed by session authorization.

The method was called with session authorization, which is prohibited for it

400

USER_ID_EMPTY

User ID can't be empty

The USER_ID parameter is not passed or its value is not greater than 0

400

MESSAGE_EMPTY

Message can't be empty

The MESSAGE parameter is not passed, is not a string, or contains only spaces

400

ATTACH_OVERSIZE

You have exceeded the maximum allowable size of attach

The size of the ATTACH attachment in JSON is 60,000 characters or more

400

ATTACH_ERROR

Incorrect attach params

The ATTACH attachment contains no valid blocks, or a string that is not JSON is passed

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

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 — 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