Эндпоинты раздела «Уведомления»

Отправка уведомлений сотрудникам Битрикс24, отметка о прочтении и удаление по идентификатору или метке. Переключайте методы во вкладках — у каждого свои параметры, поля ответа и коды ошибок.

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

Отправить уведомление

POST /v1/notifications

Отправляет уведомление сотруднику Битрикс24 — оно появляется в разделе «Уведомления» портала.

Поля запроса (body)

Поле Тип Обяз. Описание
userId number да ID сотрудника-получателя. Список: GET /v1/users
message string да Текст уведомления
type string нет personal — личное уведомление от имени приложения, system — служебное сообщение портала. По умолчанию personal
tag string нет Метка уведомления. По ней уведомления удаляются группой через DELETE /v1/notifications/by-tag/:tag
subTag string нет Дополнительная метка внутри tag
messageOut string нет Отдельный текст для внешнего мессенджера, если он подключён у получателя

Примеры

curl — личный ключ

Terminal 
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 перешла в стадию «Оплачено»"
  }'

curl — OAuth-приложение

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

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    userId: 1,
    message: 'Сделка №1024 перешла в стадию «Оплачено»',
  }),
})

const body = await res.json()
console.log('ID уведомления:', body.data.notificationId)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    userId: 1,
    message: 'Сделка №1024 перешла в стадию «Оплачено»',
  }),
})

Поля ответа

Поле Тип Описание
success boolean true при успешной доставке
data.notificationId number Идентификатор созданного уведомления. Передайте его в `DELETE /v1/notifications/:id`, чтобы удалить уведомление

Пример ответа

HTTP 201:

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

Пример ответа при ошибке

422 — уведомление не доставлено:

JSON 
{
  "success": false,
  "error": {
    "code": "NOTIFICATION_NOT_DELIVERED",
    "message": "Bitrix24 did not create the notification (returned false). The userId may not exist on the portal or may be deactivated."
  }
}

Ошибки

HTTP Код Описание
400 MISSING_PARAMS Не передан userId или message
422 NOTIFICATION_NOT_DELIVERED Уведомление не создано — получателя нет на портале или он деактивирован
403 SCOPE_DENIED У ключа нет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «только чтение»
401 TOKEN_MISSING У ключа нет настроенных токенов

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

Известные особенности

  • Каждый вызов создаёт новое уведомление с новым notificationId. Повторная отправка одного текста показывает получателю несколько уведомлений — для однократного показа удаляйте прежнее уведомление или отправляйте с общей меткой tag.

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