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

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

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

Scope: базовый

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

Событие ONAPPINSTALL вызывается сразу после успешной установки приложения на Битрикс24. Приложение без интерфейса получает событие также при обновлении.

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

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

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

{
    "event": "ONAPPINSTALL",
    "event_handler_id": "11",
    "data": {
        "VERSION": "1",
        "ACTIVE": "Y",
        "INSTALLED": "Y",
        "LANGUAGE_ID": "ru"
    },
    "ts": "1696527000",
    "auth": {
        "domain": "some-domain.bitrix24.ru",
        "scope": "crm,user",
        "access_token": "s6p6eclrvim6da22ft9ch94ekreb52lv",
        "refresh_token": "4s386p3q0tr8dy89xvmt96234v3dljg8",
        "expires_in": "3600",
        "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

event_handler_id
integer

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

data*
object

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

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

ts*
timestamp

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

auth*
object

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

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

Параметр data

Название
тип

Описание

VERSION*
string

Номер установленной версии приложения, например 1

ACTIVE*
string

Статус активности приложения. Всегда Y: неактивным приложениям события не отправляются

INSTALLED*
string

Готово ли приложение к использованию. Всегда Y: до завершения установки события не отправляются

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, подробнее.

Если у приложения нет интерфейса и указан URL установки, Битрикс24 сам регистрирует на этот адрес обработчик ONAPPINSTALL при установке.

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

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

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