событие scope: базовый

ONAPPINSTALL

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

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

Описание

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

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

Параметры

event string обязательный

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

data object обязательный

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

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

ts timestamp обязательный

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

auth object обязательный

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

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

Параметр data

VERSION string обязательный

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

ACTIVE string обязательный

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

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

INSTALLED string обязательный

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

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

LANGUAGE_ID string обязательный

Установленный язык: 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 обязательный

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