Событие при изменении статуса документа OnSignB2eDocumentStatusChanged

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: sign.b2e

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

СобытиеOnSignB2eDocumentStatusChanged срабатывает при изменении статуса документа.

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

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

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

{
            "event": "ONSIGNB2EDOCUMENTSTATUSCHANGED",
            "event_handler_id": "1213",
            "data": {
                "documentUid": "R-LK-50JI-3AAK-WS1A",
                "statusCode": "signing",
                "statusName": "Signing in progress"
            },
            "ts": "1770374899",
            "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

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

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

event_handler_id
integer

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

data
object

Объект, содержащий информацию о документе

data.documentUid
string

Уникальный идентификатор документа

data.companyUid
string

Уникальный идентификатор компании. Возвращается в событии, если документ подписывается с компанией, для которой создана интеграция

data.statusCode
string

Код статуса документа

data.statusName
string

Название статуса документа

ts
timestamp

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

auth
object

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

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

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

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

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

Предыдущая
Обзор событий
Следующая
При изменении статуса участника