Событие при добавлении пользователя onUserAdd

Scope: базовый

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

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

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

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

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

{
            "event": "ONUSERADD",
            "data": {
                "ID": 123,
                "ACTIVE": "Y",
                "EMAIL": "user@example.ru",
                "NAME": "Иван",
                "LAST_NAME": "Иванов",
                "PERSONAL_GENDER": "M",
                "PERSONAL_BIRTHDAY": "1990-01-01",
                "UF_DEPARTMENT": [1, 2],
                "DATE_REGISTER": "2024-04-05T10:00:00+03:00",
                "WORK_POSITION": "Разработчик",
                "UF_EMPLOYMENT_DATE": "2024-04-05"
            },
            "ts": "1466439714",
            "auth": {
                "domain": "some-domain.bitrix24.ru",
                "server_endpoint": "https://oauth.bitrix24.tech/rest/", 
                "client_endpoint": "https://some-domain.bitrix24.ru/rest/", 
                "member_id": "a223c6b3710f85df22e9377d6c4f7553"
            }
        }

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

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

Название
тип

Описание

event*
string

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

data*
object

Данные добавленного пользователя.

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

ts*
timestamp

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

auth*
object

Данные авторизации и портала.

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

Параметр data

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

Название
тип

Описание

ID*
integer

Идентификатор пользователя

ACTIVE*
string

Флаг активности.

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

  • Y — да
  • N — нет

EMAIL
string

Email пользователя

NAME
string

Имя пользователя

LAST_NAME
string

Фамилия пользователя

PERSONAL_GENDER
string

Пол: M — мужской, F — женский

PERSONAL_BIRTHDAY
string

Дата рождения в формате YYYY-MM-DD

UF_DEPARTMENT
array|null

Массив ID подразделений. Может отсутствовать для пользователей Экстранет

DATE_REGISTER*
string

Дата регистрации в формате ISO 8601

WORK_POSITION
string

Должность пользователя

UF_EMPLOYMENT_DATE
string

Дата приема на работу в формате YYYY-MM-DD

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

Параметр auth

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

Название
тип

Описание

access_token*
string

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

expires_in*
integer

Время в секундах до истечения срока действия токена

scope*
string

Скоуп, в рамках которого произошло событие

domain*
string

Адрес Битрикс24, на котором произошло событие

server_endpoint*
string

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

status*
string

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

client_endpoint*
string

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

member_id*
string

Идентификатор Битрикс24, на котором произошло событие

refresh_token*
string

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

application_token*
string

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

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

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