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.

You can obtain the user ID using the user.get or user.search methods.

TYPE
string

The type of notification.

Allowed values:

  • USER — personal notification
  • SYSTEM — system notification

Default value — USER

MESSAGE*
string

The text of the notification. The method trims whitespace from the ends of the string before sending.

MESSAGE_OUT
string

The text of the notification for external channels, such as email.

TAG
string

A unique tag for the notification within the application. When adding a notification with an existing tag, other notifications will be removed. Pass it with CLIENT_ID when calling via webhook.

SUB_TAG
string

An additional notification tag without uniqueness checks. Pass it with CLIENT_ID when calling via webhook.

ATTACH
object
string

An attachment for the notification in object format or JSON string. For more details, see the Attachments section.

CLIENT_ID
string

The application identifier. The parameter is required only when calling via a webhook: pass it together with TAG and SUB_TAG

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":"USER","MESSAGE":"Reminder","MESSAGE_OUT":"Reminder (email)","TAG":"TASK_42","SUB_TAG":"TASK|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":"System message","MESSAGE_OUT":"System message (email)","TAG":"SYSTEM_42","SUB_TAG":"SYSTEM|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: 'USER',
              MESSAGE: 'Reminder',
              MESSAGE_OUT: 'Reminder (email)',
              TAG: 'TASK_42',
              SUB_TAG: 'TASK|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: 'USER',
                  MESSAGE: 'Reminder',
                  MESSAGE_OUT: 'Reminder (email)',
                  TAG: 'TASK_42',
                  SUB_TAG: 'TASK|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="USER",
                message="Notification",
                message_out="Notification (email)",
                tag="TASK_42",
                sub_tag="TASK|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' => 'USER',
                    'MESSAGE' => 'Reminder',
                    'MESSAGE_OUT' => 'Reminder (email)',
                    'TAG' => 'TASK_42',
                    'SUB_TAG' => 'TASK|42',
                ]
            );
        
            $result = $response->getResponseData()->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Notification ID: ' . $result->data();
            }
        } catch (Throwable $exception) {
            echo $exception->getMessage();
        }
        
BX24.callMethod(
            'im.notify',
            {
                USER_ID: 5,
                TYPE: 'USER',
                MESSAGE: 'Reminder',
                MESSAGE_OUT: 'Reminder (email)',
                TAG: 'TASK_42',
                SUB_TAG: 'TASK|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' => 'USER',
                'MESSAGE' => 'Reminder',
                'MESSAGE_OUT' => 'Reminder (email)',
                'TAG' => 'TASK_42',
                'SUB_TAG' => 'TASK|42',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } 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":        "USER",
        	"MESSAGE":     "Reminder",
        	"MESSAGE_OUT": "Reminder (email)",
        	"TAG":         "TASK_42",
        	"SUB_TAG":     "TASK|42",
        })
        if err != nil {
        	return fmt.Errorf("im.notify: %w", err)
        }
        
        var value b24.ID
        if err := json.Unmarshal(res.Result, &value); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("result:", value)
        

Response Handling

HTTP Status: 200

{
            "result": 12345,
            "time": {
                "start": 1760000000.0,
                "finish": 1760000000.1,
                "duration": 0.1,
                "processing": 0.04,
                "date_start": "2026-03-03T10:00:00+01:00",
                "date_finish": "2026-03-03T10:00:00+01:00",
                "operating_reset_at": 1760030000,
                "operating": 0
            }
        }
        

Returned Data

Name
Type

Description

result
integer
boolean

The identifier of the created notification. If the notification was not created, it may return false.

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

Code

Description

Value

WRONG_AUTH_TYPE

Access for this method not allowed by session authorization.

The method was called with session authorization, which is prohibited.

USER_ID_EMPTY

User ID can't be empty

The USER_ID parameter was not provided, or USER_ID <= 0.

MESSAGE_EMPTY

Message can't be empty

The message text was not provided.

ATTACH_OVERSIZE

You have exceeded the maximum allowable size of attach

The maximum allowable size for the ATTACH is exceeded — 60,000 characters.

ATTACH_ERROR

Incorrect attach params

An incorrect format for the ATTACH was provided.

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