Событие после успешной установки приложения OnAppInstall

Scope: базовый

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

Событие OnAppInstall вызывается сразу после успешной установки приложения на Битрикс24. В обработчик передается application_token, который важно сохранить. Подробнее читайте в статье Безопасность в обработчиках.

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

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

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

{
            "event": "ONAPPINSTALL",
            "data": {
                "VERSION": "1.0.0",
                "ACTIVE": "Y",
                "INSTALLED": "Y",
                "LANGUAGE_ID": "ru"
            },
            "ts": "1696527000",
            "auth": {
                "domain": "some-domain.bitrix24.ru",
                "server_endpoint": "https://oauth.bitrix24.tech/rest/",
                "status": "F",
                "client_endpoint": "https://some-domain.bitrix24.ru/rest/",
                "member_id": "a223c6b3710f85df22e9377d6c4f7553",
                "application_token": "51856fefc120afa4b628cc82d3935cce"
            }
        }

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

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

Название
тип

Описание

event*
string

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

data*
object

Данные об установленном приложении.

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

ts*
timestamp

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

auth*
object

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

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

Параметр data

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

Название
тип

Описание

LANGUAGE_ID*
string

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

VERSION*
integer

Версия установленного приложения

ACTIVE*
string

Статус активности приложения.

Возможные значения:
Y — активно
N — неактивно

INSTALLED*
string

Готово ли приложение к использованию.

Возможные значения:
Y — готово
N — не установлено полностью

Параметр auth

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

Название
тип

Описание

domain*
string

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

server_endpoint*
string

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

status*
string

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

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

client_endpoint*
string

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

member_id*
string

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

application_token*
string

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

Обработчик данного события можно установить в установочном скрипте приложения, который указывается в карточке версии в отдельном поле.

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

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