Notifications

Notifications for Bitrix24 users: sending personal and system notifications, reading the feed with its unread counter, searching the history, marking as read, answering a notification and pressing its button, deleting by ID, by tag, or all at once, notification groups, and delivery settings per channel. Notifications appear in the Notifications section of the Bitrix24 account.

Scope: im | Base URL: https://vibecode.bitrix24.com/v1 | Authorization: X-Api-Key

Documentation sections | Quick start | Full example | Endpoint reference | Error codes

Documentation sections

• Endpoints — sending, the feed, the type dictionary, search, marking as read, answering a notification, pressing a button, deletion
• Notification groups — reading, creating, renaming and deleting groups, adding and removing conditions
• Notification settings — delivery channels per module event and the settings mode

Quick start

Send a notification to a user by their userId:

curl -X POST "https://vibecode.bitrix24.com/v1/notifications" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "userId": 1, "message": "Deal #1024 moved to the Paid stage" }'

Response (HTTP 201):

{
  "success": true,
  "data": {
    "notificationId": 37421
  }
}

Full example

Send a notification, mark it as read, and delete it:

const BASE = 'https://vibecode.bitrix24.com/v1'
const headers = {
  'X-Api-Key': 'YOUR_API_KEY',
  'Content-Type': 'application/json',
}

// 1. Send
const sendRes = await fetch(`${BASE}/notifications`, {
  method: 'POST',
  headers,
  body: JSON.stringify({ userId: 1, message: 'Deal #1024 moved to the Paid stage' }),
})
const { data } = await sendRes.json()
const id = data.notificationId

// 2. Mark as read
await fetch(`${BASE}/notifications/read`, {
  method: 'POST',
  headers,
  body: JSON.stringify({ id, onlyCurrent: true }),
})

// 3. Delete
const delRes = await fetch(`${BASE}/notifications/${id}`, {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
console.log('Deleted:', delRes.status === 204)

Endpoint reference

Interactive method switcher with examples and response fields — Endpoints.

Error codes

Full list of common API errors — Errors.

See also

• Send a notification
• Employees
• Chats and messages
• Errors