Событие при подписании документа HCM Link OnSignHcmLinkB2eDocumentSigned

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

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

Scope: sign.b2e

Кто может подписаться: пользователь с доступом к КЭДО

Событие ONSIGNHCMLINKB2EDOCUMENTSIGNED срабатывает после подписания документа КЭДО, который связан с HCM Link.

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

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

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

{
    "event": "ONSIGNHCMLINKB2EDOCUMENTSIGNED",
    "event_handler_id": "1215",
    "data": {
        "id": 3942,
        "company": "acme-hr"
    },
    "ts": "1786086930",
    "auth": {
        "access_token": "s6p6eclrvim6da22ft9ch94ekreb52lv",
        "expires_in": "3600",
        "scope": "sign.b2e",
        "domain": "some-domain.bitrix24.ru",
        "server_endpoint": "https://oauth.bitrix24.tech/rest/",
        "status": "L",
        "client_endpoint": "https://some-domain.bitrix24.ru/rest/",
        "member_id": "60133c09d1f5d0fd6d7884a11fad4585",
        "refresh_token": "4s386p3q0tr8dy89xvmt96234v3dljg8",
        "application_token": "81905784dd6e05280c9a2015e0e61e68"
    }
}

Параметр
тип

Описание

event
string

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

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

event_handler_id
integer

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

data
object

Объект, содержащий данные о подписанном документе HCM Link

data.id
integer

Идентификатор участника подписания. Передайте его в параметр id метода sign.b2e.hcmlink.document.get, чтобы получить данные подписанного документа

data.company
string

Код компании HCM Link

ts
timestamp

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

auth
object

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

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

Параметр 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 в коде.

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

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