Overview of Events When Working with Custom Deal Fields

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

Events allow applications to receive notifications regarding changes to custom deal field configurations: creating, updating, or deleting a field, as well as modifying the set of values for a list-type field.

They are not triggered when the value of a custom field is changed within a specific deal. To track a field value change in a deal, subscribe to the onCrmDealUpdate deal update event. The current field value can be retrieved using the crm.deal.get method.

Detailed information on working with events is described in the article Concept and Benefits of Event Processing.

Quick navigation: All Events

How to Receive Events

You can subscribe to events for custom deal fields through:

An example of a handler for the event is described in the article How to Test Your Handler for Processing Events in Bitrix24.

Server Availability for Sending and Receiving Events

The event handler server must be accessible from the outside. To configure the accessibility of the event handler server and application, refer to the article Required network access.

For cloud Bitrix24, no additional configuration is required. For on-premise Bitrix24, configure accessibility on the server or hosting according to the article Required network access.

Overview of Events

Scope: crm

Who can subscribe: Any user

Event

Triggered

onCrmDealUserFieldAdd

When a custom field is added manually or via the method crm.deal.userfield.add

onCrmDealUserFieldUpdate

When a custom field is changed manually or via the method crm.deal.userfield.update

onCrmDealUserFieldDelete

When a custom field is deleted manually or via the method crm.deal.userfield.delete

onCrmDealUserFieldSetEnumValues

When the set of values for a list-type custom field is changed manually or via the method crm.deal.userfield.update