Event onCrmDealUserFieldDelete

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

Who can subscribe: any user

The onCrmDealUserFieldDelete event will trigger when a custom field is deleted manually or via the crm.deal.userfield.delete method.

The event refers to the configuration of a custom field rather than the value of this field in a specific deal.

What the Handler Receives

Data is transmitted as a POST request

{
            "event": "ONCRMDEALUSERFIELDDELETE",
            "event_handler_id": "663",
            "data": {
                "FIELDS": {
                    "ID": "5227",
                    "ENTITY_ID": "CRM_DEAL",
                    "FIELD_NAME": "UF_CRM_1592601331"
                }
            },
            "ts": "1736943852",
            "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",
                "application_token": "51856fefc120afa4b628cc82d3935cce"
            }
        }

parameter
type

Description

event
string

Symbolic code of the event.

In this case — ONCRMDEALUSERFIELDDELETE

event_handler_id
integer

Identifier of the event handler

data
object

Object containing information about the deleted custom field.

Contains a single key FIELDS

data.FIELDS
object

An object with the ID and code of the custom field.

The structure is described below

ts
timestamp

Date and time of the event 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 custom field

ENTITY_ID
string

Symbolic code of the object the field belongs to. In this case — CRM_DEAL

FIELD_NAME
string

Custom field code with the UF_CRM_ prefix

The settings of the deleted field are not included in the event and cannot be retrieved after deletion: the crm.deal.userfield.get method with the ID from the event returns the ERROR_NOT_FOUND error.

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:

  • L — local application
  • F — free mass-market application
  • D — demo version of a mass-market application
  • T — trial version of a mass-market application, time-limited
  • P — paid mass-market application

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 Updating a Custom Field
Next
When Changing the Set of Values for a List-Type Custom Field