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

ONAPPUSERREADY

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

Кто может подписаться: обработчик приложения регистрируется автоматически

Описание

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

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

В отличие от ONAPPINSTALL, событие ONAPPUSERREADY приходит при немедленном и отложенном завершении установки приложения и передает долгоживущую авторизацию системного пользователя. Если приложению нужна работа без участия сотрудника, опирайтесь на событие ONAPPUSERREADY.

Параметры

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

Символьный код события.

В данном случае — ONAPPUSERREADY

event_handler_id integer необязательный

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

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

Объект с параметрами авторизации системного пользователя.

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

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

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

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

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

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

Параметр data

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

Токен доступа системного пользователя

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

Токен для продления авторизации системного пользователя

expires_in integer обязательный

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

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

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

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

Домен сервера авторизации

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

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

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

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

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

Идентификатор Битрикс24

user_id integer обязательный

Идентификатор системного пользователя в Битрикс24

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

Идентификатор приложения

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

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

Возможные значения:

L — локальное приложение
S, T, D, P — варианты тиражного приложения

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

Язык Битрикс24 на момент установки приложения

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

Дата и время окончания подписки, если они известны Битрикс24

Параметр auth

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

Токен для обращения к API

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

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