Notifications in Chats: Overview of Methods

A chat notification is a message containing information from the system or a user. The group of methods im.notify.* manages notifications.

Quick Navigation: All Methods and Events
User Documentation: Notifications in Bitrix24

Linking Notifications to Other ObjectsLinking Notifications to Other Objects

User. A notification is sent to a user by their USER_ID. You can obtain the user ID using the user.get method.

Send NotificationSend Notification

You can send a message with information to the messenger, which will appear in the notifications list.

• Universal Method. The im.notify method sends a personal or system notification via the TYPE parameter.

• Personal Notification. An employee will receive a notification on behalf of the user who initiated the method. The im.notify.personal.add method sends a personal notification.

• System Notification. The im.notify.system.add method sends a notification from the system.

Each notification can be associated with a unique tag TAG. If a new notification is sent with the same tag, the system will remove the previous notification.

All sending methods return the notification ID, which can be used in other methods.

Get NotificationsGet Notifications

The im.notify.get method returns the current notifications with pagination.

The im.notify.schema.get method returns the available notification types by modules.

Read NotificationsRead Notifications

The im.notify.read.list method manages the Read label for the list of notifications, except for the CONFIRM type with confirmation buttons. Using the ACTION parameter, you can mark notifications as read Y or unread N.

The im.notify.read method reads a single notification or all notifications after a specified one. The ONLY_CURRENT parameter defines the scope:

• Y — the Read label will be set only for the specified notification,

• N or absence of the parameter — for all notifications with ID equal to or greater than the specified one.

The im.notify.read.all method marks all notifications of the current user as read.

Delete NotificationDelete Notification

The im.notify.delete method deletes a notification by its ID or by tags TAG, SUB_TAG.

Reply to NotificationReply to Notification

You can reply to a notification that supports quick responses using the im.notify.answer method.

You can interact with buttons in the notification using the im.notify.confirm method. The NOTIFY_VALUE parameter should contain the button value. For example, for a meeting invitation notification, the Accept button has a value of Y, and the Decline button has a value of N.

Search Notification HistorySearch Notification History

The im.notify.history.search method performs a search through the notification history with filters for text, type, date, and group tag.

Overview of MethodsOverview of Methods

Scope: im
Who can execute the method: any user

Method	Description
im.notify	Sends a notification
im.notify.personal.add	Sends a personal notification
im.notify.system.add	Sends a system notification
im.notify.get	Returns user notifications
im.notify.schema.get	Returns the notification types schema
im.notify.read.list	Reads the list of notifications
im.notify.read	Reads a notification or returns it as unread
im.notify.read.all	Reads all notifications
im.notify.answer	Replies to a notification that supports quick response
im.notify.confirm	Interacts with notification buttons
im.notify.delete	Deletes notifications
im.notify.history.search	Searches through notification history