Уведомления

Уведомления сотрудникам Битрикс24: отправка личных и системных уведомлений, чтение ленты со счётчиком непрочитанных, поиск по истории, отметка о прочтении, ответ на уведомление и нажатие его кнопки, удаление по идентификатору, по метке или всех сразу, группы уведомлений и настройки доставки по каналам. Уведомления приходят в раздел «Уведомления» портала.

Скоуп: im | Базовый URL: https://vibecode.bitrix24.tech/v1 | Авторизация: X-Api-Key

Разделы документации | Быстрый старт | Полный пример | Справочник эндпоинтов | Коды ошибок

Разделы документации

• Эндпоинты — отправка, лента, словарь типов, поиск, отметка о прочтении, ответ на уведомление, нажатие кнопки, удаление
• Группы уведомлений — чтение, создание, переименование и удаление групп, добавление и удаление условий
• Настройки уведомлений — каналы доставки по событиям модулей и режим настроек

Быстрый старт

Отправьте уведомление сотруднику по его userId:

curl -X POST "https://vibecode.bitrix24.tech/v1/notifications" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "userId": 1, "message": "Сделка №1024 перешла в стадию «Оплачено»" }'

Ответ (HTTP 201):

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

Полный пример

Отправить уведомление, отметить его прочитанным и удалить:

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

// 1. Отправить
const sendRes = await fetch(`${BASE}/notifications`, {
  method: 'POST',
  headers,
  body: JSON.stringify({ userId: 1, message: 'Сделка №1024 перешла в стадию «Оплачено»' }),
})
const { data } = await sendRes.json()
const id = data.notificationId

// 2. Отметить прочитанным
await fetch(`${BASE}/notifications/read`, {
  method: 'POST',
  headers,
  body: JSON.stringify({ id, onlyCurrent: true }),
})

// 3. Удалить
const delRes = await fetch(`${BASE}/notifications/${id}`, {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
console.log('Удалено:', delRes.status === 204)

Справочник эндпоинтов

Интерактивный переключатель методов с примерами и полями ответа — Эндпоинты.

Коды ошибок

Полный список общих ошибок API — Ошибки.

Смотрите также

• Отправить уведомление
• Сотрудники
• Чаты и сообщения
• Ошибки