Event on Document Status Change OnSignB2eDocumentStatusChanged

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the MCP server so that the assistant can utilize the official REST documentation.

Scope: sign.b2e

Who can subscribe: a user with access to KEDO

The event OnSignB2eDocumentStatusChanged is triggered when the status of a document changes.

Events will not be sent to the application until the installation is complete. Check the application installation

What the Handler Receives

Data is transmitted as a POST request

{
            "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.com",
                "server_endpoint": "https://oauth.bitrix.info/rest/",
                "status": "L",
                "client_endpoint": "https://some-domain.bitrix24.com/rest/",
                "member_id": "60133c09d1f5d0fd6d7884a11fad4585",
                "refresh_token": "4s386p3q0tr8dy89xvmt96234v3dljg8",
                "application_token": "81905784dd6e05280c9a2015e0e61e68"
            }
        }

Parameter
type

Description

event
string

Symbolic event code.

In this case — ONSIGNB2EDOCUMENTSTATUSCHANGED

event_handler_id
integer

Event handler identifier

data
object

Object containing information about the document

data.documentUid
string

Unique document identifier

data.companyUid
string

Unique company identifier. Returned in the event if the document is signed with the company for which the integration was created

data.statusCode
string

Document status code

data.statusName
string

Document status name

ts
timestamp

Date and time the event was sent from the event queue

auth
object

Object with authorization parameters and portal data.

The structure is described below

Parameter auth

Required parameters are marked with *

Name
type

Description

access_token
string

Authorization token OAuth 2.0

expires_in
integer

Time in seconds until the token expires

scope*
string

Scope under which the event occurred

domain*
string

Address of Bitrix24 where the event occurred

server_endpoint*
string

Address of the Bitrix24 authorization server needed to refresh OAuth 2.0 tokens

status*
string

Status of the application that subscribed to this event:

client_endpoint*
string

Common path for REST API method calls for Bitrix24 where the event occurred

member_id*
string

Identifier of Bitrix24 where the event occurred

refresh_token
string

Token for extending authorization OAuth 2.0

application_token*
string

Token for secure event handling

Authorization tokens are not always passed to the event handler. If the hit that initiated the event could not be linked to a specific Bitrix24 user, the tokens are not passed. Always check the contents of the auth key in the code.

It is recommended to store tokens obtained earlier during the application installation. Use them when working with the application interface in the form of embeds, widgets, and so on.

Continue Your Exploration

Previous
Overview of Events
Next
When Participant Status Changes