When updating a custom field onCrmQuoteUserFieldUpdate
Scope:
crmWho can subscribe: any user
The event ONCRMQUOTEUSERFIELDUPDATE will trigger when a custom field is updated for estimates.
What the handler receives
Data is sent as a POST request
{
"event": "ONCRMQUOTEUSERFIELDUPDATE",
"event_handler_id": "755",
"data": {
"FIELDS": {
"ID": "6841",
"ENTITY_ID": "CRM_QUOTE",
"FIELD_NAME": "UF_CRM_6710EFCA2D1C0"
}
},
"ts": "1743678840",
"auth": {
"access_token": "s6p6eclrvim6da22ft9ch94ekreb52lv",
"expires_in": "3600",
"scope": "crm",
"domain": "some-domain.bitrix24.com",
"server_endpoint": "https://oauth.bitrix.info/rest/",
"status": "L",
"client_endpoint": "https://some-domain.bitrix24.com/rest/",
"member_id": "a223c6b3710f85df22e9377d6c4f7553",
"refresh_token": "4s386p3q0tr8dy89xvmt96234v3dljg8",
"application_token": "51856fefc120afa4b628cc82d3935cce"
}
}
|
Parameter |
Description |
|
event |
Symbolic event code. In this case — |
|
event_handler_id |
Event handler identifier |
|
data |
Object containing information about the updated custom field. Contains the key |
|
data.FIELDS |
Object containing information about the fields of the updated custom field. The structure is described below |
|
ts |
Date and time the event was sent from the event queue |
|
auth |
Object containing authorization parameters and information about the account where the event occurred. The structure is described below |
Parameter FIELDS
|
Parameter |
Description |
|
ID |
Identifier of the updated custom field |
|
ENTITY_ID |
Identifier of the object to which the custom field belongs. In this case — |
|
FIELD_NAME |
Name of the updated custom field |
Parameter auth
Required parameters are marked with *
|
Name |
Description |
|
access_token |
Authorization token OAuth 2.0 |
|
expires_in |
Time in seconds until the token expires |
|
scope* |
Scope under which the event occurred |
|
domain* |
Address of Bitrix24 where the event occurred |
|
server_endpoint* |
Address of the Bitrix24 authorization server needed to refresh OAuth 2.0 tokens |
|
status* |
Status of the application that subscribed to this event:
|
|
client_endpoint* |
Common path for REST API method calls for Bitrix24 where the event occurred |
|
member_id* |
Identifier of Bitrix24 where the event occurred |
|
refresh_token |
Token for extending authorization OAuth 2.0 |
|
application_token* |
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 exploring
- Event Handler
- Register a new event handler event.bind
- When Adding a Custom Field onCrmQuoteUserFieldAdd
- When Deleting a Custom Field onCrmQuoteUserFieldDelete