Event onUserAdd

Scope: basic

Who can subscribe: any user

The onUserAdd event is triggered when a user is added to Bitrix24. The event occurs not after the invitation, but after the user logs into the account and completes the registration process.

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": "ONUSERADD",
            "data": {
                "ID": 123,
                "ACTIVE": "Y",
                "EMAIL": "user@example.com",
                "NAME": "John",
                "LAST_NAME": "Doe",
                "PERSONAL_GENDER": "M",
                "PERSONAL_BIRTHDAY": "1990-01-01",
                "UF_DEPARTMENT": [1, 2],
                "DATE_REGISTER": "2024-04-05T10:00:00+02:00",
                "WORK_POSITION": "Developer",
                "UF_EMPLOYMENT_DATE": "2024-04-05"
            },
            "ts": "1466439714",
            "auth": {
                "domain": "some-domain.bitrix24.com",
                "server_endpoint": "https://oauth.bitrix.info/rest/", 
                "client_endpoint": "https://some-domain.bitrix24.com/rest/", 
                "member_id": "a223c6b3710f85df22e9377d6c4f7553"
            }
        }

Request parameters

Required parameters are marked with *

Name
type

Description

event*
string

Symbolic event code — ONUSERADD

data*
object

Data of the added user.

The structure is described below

ts*
timestamp

Date and time the event was sent

auth*
object

Authorization and account data.

The structure is described below

Parameter data

Required parameters are marked with *

Name
type

Description

ID*
integer

User identifier

ACTIVE*
string

Active flag.

Possible values:

  • Y — yes
  • N — no

EMAIL
string

User's email

NAME
string

User's first name

LAST_NAME
string

User's last name

PERSONAL_GENDER
string

Gender: M — male, F — female

PERSONAL_BIRTHDAY
string

Date of birth in YYYY-MM-DD format

UF_DEPARTMENT
array|null

Array of department IDs. May be absent for Extranet users

DATE_REGISTER*
string

Registration date in ISO 8601 format

WORK_POSITION
string

User's job title

UF_EMPLOYMENT_DATE
string

Employment date in YYYY-MM-DD format

Some fields may be absent or have a value of null if the application does not have access to them.

Parameter auth

Required parameters are marked with *

Name
type

Description

access_token*
string

Token for accessing the API

expires_in*
integer

Time in seconds until the token expires

scope*
string

Scope under which the event occurred

domain*
string

Bitrix24 address where the event occurred

server_endpoint*
string

Bitrix24 authorization server address needed for refreshing OAuth 2.0 tokens

status*
string

Status of the application that subscribed to this event:

client_endpoint*
string

Common path for API method calls for Bitrix24 where the event occurred

member_id*
string

Identifier of Bitrix24 where the event occurred

refresh_token*
string

Token for renewing authorization OAuth 2.0

application_token*
string

Token for secure event processing

Continue your exploration

Previous
When Receiving Permission to Use Methods
Next
Overview of methods