Notifications in Chats: Overview of Methods

A chat notification is a message containing information from the system or a user. It arrives in the messenger notification center, not in the chat conversation. The group of methods im.notify.* manages notifications. The subsection is part of the Chats in Bitrix24 section.

The im.notify.* methods are current and have no deprecated variants.

Quick navigation: all methods

User documentation: Notifications in Bitrix24

Personal and System NotificationPersonal and System Notification

Notifications come in two types, and the type determines on whose behalf the message arrives:

• a personal notification arrives on behalf of the user who called the method. The USER type in the TYPE parameter, which is also used by default
• a system notification arrives on behalf of the system, without an author. The SYSTEM type

Notification or MessageNotification or Message

Task	What to Use
Inform a user about an event in the integration without creating a conversation	The im.notify.* methods of this subsection
Write to a dialogue or a group chat	im.message.add from the Messages subsection
Find out the number of unread messages and notifications	im.counters.get

How to Get StartedHow to Get Started

1. Retrieve the recipient identifier with the user.get method
2. Send the notification with the im.notify method and choose the type in the TYPE parameter
3. Retain the notification identifier from the response — it is needed for the read, reply, and delete methods
4. Manage the state of the notifications with the im.notify.read, im.notify.read.list, and im.notify.delete methods

Linking Notifications to Other ObjectsLinking Notifications to Other Objects

User. A notification goes to the user specified in USER_ID. You can obtain the user identifier using the user.get method.

Application. Notification tags are bound to the application. The TAG tag is unique within it: if a new notification is sent with the same TAG, the system removes the previous one. SUB_TAG is an auxiliary tag without a uniqueness check. When calling via a webhook, both tags are passed together with CLIENT_ID.

Attachments. Structured content can be attached to a notification in the ATTACH parameter — the format is described in the Attachments article.

Search. The im.notify.history.search method helps you find a notification in the history, and the search across chats, employees, and departments is collected in the Search subsection.

How to Choose a MethodHow to Choose a Method

Task	Method
Send a notification	im.notify — one method for both types, the type is set by the TYPE parameter. The separate methods im.notify.personal.add and im.notify.system.add solve the same tasks
Retrieve notifications and types	im.notify.get, im.notify.schema.get
Manage the read status	im.notify.read — a single notification, im.notify.read.list — a list, im.notify.read.all — all
Reply or press a button	im.notify.answer, im.notify.confirm
Delete or find in the history	im.notify.delete, im.notify.history.search

Limits and PaginationLimits and Pagination

• the im.notify.get and im.notify.history.search methods return the selection page by page using a cursor, with a maximum of 50 notifications per page
• the size of the serialized ATTACH attachment is limited to 60,000 characters

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	Marks a list of notifications as read
im.notify.read	Marks a notification as read or returns it to unread
im.notify.read.all	Marks all notifications as read
im.notify.answer	Replies to a notification with a quick response
im.notify.confirm	Interacts with notification buttons
im.notify.delete	Deletes notifications
im.notify.history.search	Searches through notification history