Event onCrmAddressRegister

Scope: crm

Who can subscribe: any user

The onCrmAddressRegister event is triggered when an address is registered.

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' => 'onCrmAddressRegister',
            'data' => [
                'FIELDS' => [
                    'TYPE_ID' => 1,
                    'ENTITY_TYPE_ID' => 8,
                    'ENTITY_ID' => 1,
                    'ANCHOR_ID' => 17192,
                    'ANCHOR_TYPE_ID' => 3,
                ],
            ],
            'ts' => '1466439714',
            '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',
            ],
        ]

Required parameters are marked with *

Parameter
type

Description

event*
string

Symbolic event code. In this case, it is onCrmAddressRegister

data*
array

Array with the registered address data

ts*
timestamp

Date and time of the event sent from the event queue

auth*
array

Authorization parameters and information about the account where the event occurred

Parameter data[]

Required parameters are marked with *

Parameter
type

Description

FIELDS*
array

Array with the fields of the registered address

Parameter FIELDS[]

Required parameters are marked with *

Parameter
type

Description

TYPE_ID*
integer

Identifier of the address type. Enumeration element "Address Type".

The enumeration elements "Address Type" are returned by the method crm.enum.addresstype

ENTITY_TYPE_ID*
integer

Identifier of the parent object type.

Object type identifiers are returned by the method crm.enum.ownertype.

Addresses can only be linked to Requisites (and requisites are linked to companies or contacts) or Leads. For backward compatibility, the ability to link Addresses to Contacts or Companies is retained. However, this link is only possible on some older accounts where the old address handling mode was specifically enabled by support

ENTITY_ID*
integer

Identifier of the parent object

ANCHOR_ID*
integer

Identifier of the main parent object.

This field is for internal use. The value is automatically filled when adding an address.

This field contains the identifier of the parent object of the requisite (company or contact) if the address is linked to the requisite. If the address is linked to a lead, then this value will be the lead identifier

ANCHOR_TYPE_ID*
integer

Identifier of the type of the main parent object.

This field is for internal use. The value is automatically filled when adding an address.

Object type identifiers are returned by the method crm.enum.ownertype.

This field contains the identifier of the type of the parent object of the requisite (company or contact) if the address is linked to the requisite. If the address is linked to a lead, then this value will be the lead type identifier

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 your study

Previous
Overview of Events
Next
When Unregistering an Address