OnCalendarSectionAdd Event When Adding a Calendar Section or Resource

Scope: calendar

Who can subscribe: any user

This event is triggered when a calendar section or resource is added.

Technically, a resource is a calendar section. Each resource is placed in a special type of calendar, and a separate section is created for it. Events OnCalendarSection* are triggered when resources are added, updated, or deleted.

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

Example: event for creating a calendar section object with id = 202.

{
            "event": "ONCALENDARSECTIONADD",
            "event_handler_id": "6",
            "data": {
                "id": "202"
            },
            "ts":"1734608536",
            "auth": {
                "access_token": "s6p6eclrvim6da22ft9ch94ekreb52lv",
                "expires_in": "3600",
                "scope": "calendar",
                "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"
            }
        }

Name
type

Description

event
string

Symbolic event code.

In this case — ONCALENDARSECTIONADD

event_handler_id
integer

Event handler identifier

data
object

Object containing information about the added calendar section object.

Contains a single key — id

data.id
string

Identifier of the calendar section object

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.

The structure is described below

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.

Continue Exploring

Previous
Overview of Events
Next
When Updating a Calendar or Resource Section