Event for Creating a Custom Type CRM Object onCrmDynamicItemAdd

Scope: crm

Who can subscribe: any user

The event will trigger when an item of any custom object type is added to CRM.

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 for creating a smart process item with entityTypeId = 1220:

{
            "event": "ONCRMDYNAMICITEMADD",
            "event_handler_id": "4",
            "data": {
                "FIELDS": {
                    "ID": "22",
                    "ENTITY_TYPE_ID": "1220"
                }
            },
            "ts": "1723534033",
            "auth": {
                "access_token": "s6p6eclrvim6da22ft9ch94ekreb52lv",
                "expires_in": "3600",
                "scope": "crm",
                "domain": "some-domain.bitrix24.com",
                "server_endpoint": "https://oauth.bitrix.info/rest/",
                "status": "F",
                "client_endpoint": "https://some-domain.bitrix24.com/rest/",
                "member_id": "a223c6b3710f85df22e9377d6c4f7553",
                "refresh_token": "4s386p3q0tr8dy89xvmt96234v3dljg8",
                "application_token": "51856fefc120afa4b628cc82d3935cce"
            }
        }

Parameter
type

Description

event
string

Symbolic event code.

In this case — ONCRMDYNAMICITEMADD

event_handler_id
integer

Identifier of the event handler

data
object

Object containing information about the created custom type CRM object.

Contains a single key FIELDS

data.FIELDS
object

Object containing information about the fields of the created custom type CRM object.

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.

Structure is described below

FIELDS Parameter

Parameter
type

Description

ID
integer

Identifier of the created custom type CRM object

ENTITY_TYPE_ID
integer

Identifier of the custom CRM type

auth Parameter

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.

System Object Type Events

Although universal CRM methods allow adding and modifying objects of standard types such as deals, leads, contacts, companies, and estimates, the onCrmDynamicItemAdd event will not trigger when adding the listed objects.

To track new deals, leads, and so on, you can use specific events:

The onCrmDynamicItemAdd event will trigger when new invoices are added.

Continue Learning

Previous
Overview of Events
Next
On Updating a Custom CRM Object