Skip to content

index.md

Latest commit

 

History

History
92 lines (64 loc) · 5.69 KB

index.md

File metadata and controls

92 lines (64 loc) · 5.69 KB
Raw

Resources: Overview of Methods and Events

{% note tip "" %}

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

{% endnote %}

Resources are objects that can be reserved: rooms, equipment, or services. The methods of this section create, modify, find, and delete resources, while the available time and types are configured in the child sections.

{% note info "" %}

The methods only work when the Booking tool is enabled in the Bitrix24 settings. Otherwise, any method of this section returns the error Booking tool is disabled. Please contact your administrator.

{% endnote %}

Quick navigation: all methods and events

User documentation: Add a resource to Booking section

How to Start

  1. Create or retrieve a resource type using booking.v1.resourceType.*
  2. Create a resource using booking.v1.resource.add
  3. Configure available time using booking.v1.resource.slots.*
  4. Pass the resource id in the resourceIds parameter of the booking.v1.booking.* methods so that the resource is included in a booking

Relationship with Other Objects

Reservation. Pass the id of the resources in the resourceIds parameter of the booking.v1.booking.* methods. A single reservation can include multiple resources.

Resource Type. A type has its own notification configurations, but a resource does not inherit them: a resource receives its own default values when created. Set the notification configurations directly in booking.v1.resource.add.

Slots. Slots define the times when a resource is available for booking: for example, only on Tuesdays and Thursdays from 11:00 AM to 3:00 PM. Slots are retained within the resource itself, so changing them triggers the onBookingResourceUpdate event, just as updating the resource does.

Overview of Methods and Events {#all-methods}

Scope: booking

Who can perform the method: any user

Resource

#| || Method | Description || || booking.v1.resource.add | Adds a new resource || || booking.v1.resource.update | Updates a resource || || booking.v1.resource.get | Retrieves a resource || || booking.v1.resource.list | Retrieves a list of resources || || booking.v1.resource.delete | Deletes a resource || |#

Resource Type

See the Resource Types section for details.

#| || Method | Description || || booking.v1.resourceType.add | Adds a new resource type || || booking.v1.resourceType.update | Updates a resource type || || booking.v1.resourceType.get | Retrieves a resource type || || booking.v1.resourceType.list | Retrieves a list of resource types || || booking.v1.resourceType.delete | Deletes a resource type || |#

Slots

See the Slots section for details.

#| || Method | Description || || booking.v1.resource.slots.set | Sets slots for the resource || || booking.v1.resource.slots.list | Retrieves slot settings for the resource || || booking.v1.resource.slots.unset | Removes slots for the resource || |#

Events

How to subscribe to events — see the Resource Events and Resource Type Events sections.

#| || Event | Triggered || || onBookingResourceAdd | When a resource is created manually or by the booking.v1.resource.add method || || onBookingResourceUpdate | When a resource is updated manually or by the booking.v1.resource.update, booking.v1.resource.slots.set, booking.v1.resource.slots.unset methods || || onBookingResourceDelete | When a resource is deleted manually or by the booking.v1.resource.delete method || || onBookingResourceTypeAdd | When a resource type is created manually or by the booking.v1.resourceType.add method || || onBookingResourceTypeUpdate | When a resource type is updated manually or by the booking.v1.resourceType.update method || || onBookingResourceTypeDelete | When a resource type is deleted by the booking.v1.resourceType.delete method || |#