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

Scope: базовый

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

Событие OnAppUpdate вызывается после установки новой версии приложения в Битрикс24. Событие передает информацию о текущей и предыдущей версиях приложения, а также обновленный application_token. Подробнее читайте в статье Безопасность в обработчиках.

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

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

{
            "event": "ONAPPUPDATE",
            "data": {
                "VERSION": "2.1.0",
                "PREVIOUS_VERSION": "2.0.3",
                "LANGUAGE_ID": "ru"
            },
            "ts": "1696527000",
            "auth": {
                "domain": "some-domain.bitrix24.ru",
                "scope": "imbot",
                "access_token": "lh8ze36o8ulgrljbyscr36c7ay5sinva",
                "refresh_token": "5f1ih5tsnsb11sc5heg3kp4ywqnjhd09",
                "expires_in": 3600,
                "member_id": "d41d8cd98f00b204e9800998ecf8427e",
                "application_token": "c917d38f6bdb84e9d9e0bfe9d585be73"
            }
        }

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

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

Название
тип

Описание

event*
string

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

data*
object

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

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

ts*
timestamp

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

auth*
object

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

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

Параметр data

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

Название
тип

Описание

LANGUAGE_ID*
string

Установленный язык: ru, en и другие

VERSION*
string

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

PREVIOUS_VERSION*
string

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

Параметр auth

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

Название
тип

Описание

domain*
string

Адрес портала Битрикс24

scope*
string

Список прав, выданных приложению, через пробел

access_token*
string

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

refresh_token*
string

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

server_endpoint*
string

Адрес сервера авторизации Битрикс24, необходимый для обновления токенов OAuth 2.0

status*
string

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

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

client_endpoint*
string

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

member_id*
string

Уникальный идентификатор портала

application_token*
string

Токен для безопасной обработки событий

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

Предыдущая
После успешной установки приложения
Следующая
При удалении приложения