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

Scope: crm

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

Событие onCrmContactUserFieldSetEnumValues срабатывает при изменении набора значений для пользовательского поля списочного типа у контактов.

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

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

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

{
          "event": "ONCRMCONTACTUSERFIELDSETENUMVALUES",
          "event_handler_id": "17",
          "data": {
            "FIELDS": {
              "ID": "554",
              "ENTITY_ID": "CRM_CONTACT",
              "FIELD_NAME": "UF_CRM_1724771514"
            }
          },
          "ts": "1724771547",
          "auth": {
            "access_token": "s6p6eclrvim6da22ft9ch94ekreb52lv",
            "expires_in": "3600",
            "scope": "crm",
            "domain": "some-domain.bitrix24.com",
            "server_endpoint": "https://oauth.bitrix24.tech/rest/",
            "status": "F",
            "client_endpoint": "https://some-domain.bitrix24.com/rest/",
            "member_id": "a223c6b3710f85df22e9377d6c4f7553",
            "refresh_token": "4s386p3q0tr8dy89xvmt96234v3dljg8",
            "application_token": "51856fefc120afa4b628cc82d3935cce"
          }
        }

Параметр
тип

Описание

event
string

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

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

event_handler_id
integer

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

data
object

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

Содержит единственный ключ FIELDS

data.FIELDS
object

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

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

ts
timestamp

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

auth
object

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

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

Параметр FIELDS

Параметр
тип

Описание

ID
integer

Идентификатор пользовательского поля у которого изменился список возможных значений

ENTITY_ID
userFieldEntityId

Тип объекта CRM, к которому привязано пользовательское поле.

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

FIELD_NAME
string

Код пользовательского поля у которого изменился список возможных значений

Параметр auth

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

Название
тип

Описание

access_token
string

Токен авторизации OAuth 2.0

expires_in
integer

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

scope*
string

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

domain*
string

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

server_endpoint*
string

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

status*
string

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

client_endpoint*
string

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

member_id*
string

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

refresh_token
string

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

application_token*
string

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

Токены авторизации не всегда передаются в обработчик события. Если хит, инициировавший событие, не удалось привязать к конкретному пользователю Битрикс24, токены не передаются. Обязательно проверяйте содержимое ключа auth в коде.

Рекомендуем хранить токены, полученные ранее при установке приложения. Используйте их при работе с интерфейсом приложения в виде встроек, виджетов и так далее.

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

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