When Deleting a Custom Field onCrmCompanyUserFieldDelete

Scope: crm

Who can subscribe: any user

The event ONCRMCOMPANYUSERFIELDDELETE will trigger when a custom field for companies is deleted.

What the Handler Receives

Data is sent as a POST request

{
            "event": "ONCRMCOMPANYUSERFIELDDELETE",
            "event_handler_id": "743",
            "data": {
                "FIELDS": {
                    "ID": "6979",
                    "ENTITY_ID": "CRM_COMPANY",
                    "FIELD_NAME": "UF_CRM_1743165530"
                }
            },
            "ts": "1743165546",
            "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
type

Description

event
string

Symbolic code of the event.

In this case — ONCRMCOMPANYUSERFIELDDELETE

event_handler_id
integer

Identifier of the event handler

data
object

Object containing information about the deleted custom field.

Contains the key FIELDS

data.FIELDS
object

Object containing information about the fields of the deleted custom field.

The structure is described below

ts
timestamp

Date and time the event was sent from the event queue

auth
object

Object containing authorization parameters and information about the account where the event occurred.

The structure is described below

Parameter FIELDS

Parameter
type

Description

ID
integer

Identifier of the deleted custom field

ENTITY_ID
string

Identifier of the object to which the custom field belonged. In this case — CRM_COMPANY

FIELD_NAME
string

Name of the deleted custom field

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 Learning

Previous
When adding a custom field
Next
When changing values for a List type field