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

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

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

Scope: user, user_brief или user_basic

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

Событие ONUSERADD вызывается при добавлении пользователя в Битрикс24. Событие срабатывает не после приглашения, а после того, как пользователь зайдет в Битрикс24 и завершит регистрацию. Для пользователей внешних типов, например почтовых пользователей и ботов, событие не отправляется.

Подписаться на событие можно через исходящий вебхук или из приложения методом event.bind. В исходящий вебхук токены OAuth 2.0 не передаются.

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

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

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

{
    "event": "ONUSERADD",
    "event_handler_id": "16",
    "data": {
        "ID": "123",
        "ACTIVE": "1",
        "EMAIL": "user@example.ru",
        "NAME": "Иван",
        "LAST_NAME": "Иванов",
        "PERSONAL_GENDER": "M",
        "PERSONAL_BIRTHDAY": "1990-01-01T03:00:00+03:00",
        "UF_DEPARTMENT": ["1", "2"],
        "DATE_REGISTER": "2024-04-05T03:00:00+03:00",
        "WORK_POSITION": "Разработчик",
        "UF_EMPLOYMENT_DATE": "2024-04-05T03:00:00+03:00"
    },
    "ts": "1466439714",
    "auth": {
        "access_token": "s6p6eclrvim6da22ft9ch94ekreb52lv",
        "expires_in": "3600",
        "scope": "user",
        "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

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

event_handler_id
integer

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

data*
object

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

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

ts*
timestamp

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

auth*
object

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

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

Параметр data

Название
тип

Описание

ID*
integer

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

ACTIVE*
string

Активен ли пользователь.

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

  • 1 — активен
  • 0 — не активен

Событие вызывается при первом входе пользователя, поэтому на практике приходит 1

EMAIL
string

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

NAME
string

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

LAST_NAME
string

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

PERSONAL_GENDER
string

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

PERSONAL_BIRTHDAY
string

Дата рождения в формате ISO 8601, например 1990-01-01T03:00:00+03:00

UF_DEPARTMENT
array

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

DATE_REGISTER*
string

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

WORK_POSITION
string

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

UF_EMPLOYMENT_DATE
string

Дата приема на работу в формате ISO 8601

В таблице перечислены основные поля. Состав зависит от прав приложения:

  • со scope user приходят стандартные поля пользователя, пользовательские поля UF_USR_* не передаются
  • с user_basic или user_brief приходит сокращенный набор полей, а вместе с user.userfield — еще и пользовательские поля UF_USR_*

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

Параметр auth

Название
тип

Описание

access_token
string

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

expires_in
integer

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

scope
string

Коды прав, выданных приложению, через запятую

domain*
string

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

server_endpoint*
string

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

status
string

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

client_endpoint*
string

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

member_id*
string

Уникальный идентификатор Битрикс24

application_token*
string

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

Если событие удалось привязать к пользователю, в auth приходят access_token, expires_in, scope и status, подробнее.

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

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