Событие после обновления приложения onAppUpdate

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: базовый

Кто может подписаться: любой пользователь

Событие ONAPPUPDATE вызывается после установки новой версии приложения в Битрикс24. Обработчик получает текущую и предыдущую версии приложения и application_token. Как выходит новая версия приложения и что происходит на Битрикс24 при обновлении, описано в статье Обновление приложений.

События не будут отправляться в приложение, пока установка не завершена. Проверьте установку приложения.

Что получает обработчик

Данные передаются в виде POST-запроса

{
    "event": "ONAPPUPDATE",
    "event_handler_id": "12",
    "data": {
        "VERSION": "3",
        "PREVIOUS_VERSION": "2",
        "LANGUAGE_ID": "ru"
    },
    "ts": "1696527000",
    "auth": {
        "domain": "some-domain.bitrix24.ru",
        "scope": "crm,user",
        "access_token": "lh8ze36o8ulgrljbyscr36c7ay5sinva",
        "refresh_token": "5f1ih5tsnsb11sc5heg3kp4ywqnjhd09",
        "expires_in": "3600",
        "server_endpoint": "https://oauth.bitrix24.tech/rest/",
        "status": "F",
        "client_endpoint": "https://some-domain.bitrix24.ru/rest/",
        "member_id": "d41d8cd98f00b204e9800998ecf8427e",
        "application_token": "c917d38f6bdb84e9d9e0bfe9d585be73"
    }
}

Параметры запроса

Обязательные параметры отмечены *

Название
тип

Описание

event*
string

Символьный код события. В данном случае — ONAPPUPDATE

event_handler_id
integer

Идентификатор обработчика события

data*
object

Данные об обновлении приложения.

Структура описана ниже

ts*
timestamp

Дата и время отправки события из очереди

auth*
object

Объект с параметрами авторизации и данными о Битрикс24, на котором произошло событие.

Структура описана ниже

Параметр data

Название
тип

Описание

VERSION*
string

Текущая установленная версия приложения

PREVIOUS_VERSION*
string

Предыдущая версия до обновления

LANGUAGE_ID*
string

Язык Битрикс24 по умолчанию: ru, en и другие

Параметр auth

Название
тип

Описание

domain*
string

Адрес Битрикс24, на котором произошло событие

scope
string

Коды прав, выданных приложению, через запятую

access_token
string

Токен авторизации OAuth 2.0

refresh_token
string

Токен для продления авторизации OAuth 2.0

expires_in
integer

Время жизни токена доступа в секундах

server_endpoint*
string

Адрес сервера авторизации для обновления токена

status
string

Статус приложения, подписавшегося на это событие:

  • L — локальное приложение
  • F — бесплатное тиражное приложение
  • S — подписное тиражное приложение

client_endpoint*
string

Общий путь для вызовов методов API Битрикс24

member_id*
string

Уникальный идентификатор Битрикс24

application_token*
string

Токен приложения. Сравните его с токеном, сохраненным при установке, чтобы убедиться, что запрос пришел из Битрикс24. Подробнее — в статье Безопасность в обработчиках

Если событие удалось привязать к пользователю, в auth приходят access_token, refresh_token, expires_in, scope и status, подробнее.

Продолжите изучение

Предыдущая
При создании системного пользователя приложения
Следующая
При удалении приложения