Tutorials: Ready-Made Use-Cases for the REST API

Tutorials are a practical guide for developers on the Bitrix24 REST API. They help address typical tasks such as creating or modifying entities and setting up integrations with external systems.

How to Use the TutorialsHow to Use the Tutorials

• As educational material for making your first requests. This is suitable for developers who are just starting to work with the Bitrix24 REST API. The tutorials will help you understand how to formulate requests and process responses. For example, the tutorial How to Attach a Task to a SPA.

• As templates for real scenarios. The tutorials can serve as a foundation for your own solutions: adapt the examples to your needs, add error handling logic, and logging. For instance, the tutorial How to Implement a Simple Cash Register Using the REST API.

• For quickly solving specific tasks. The tutorials will help you find a ready-made code example that you can use immediately. For example, the tutorial How to Set Up Rounding for a Custom Number Field.

Structure of the TutorialsStructure of the Tutorials

The tutorials consist of:

• a brief description of the task being solved,
• examples of methods in PHP and JavaScript,
• descriptions of the parameters used,
• examples of server responses in JSON format,
• examples of general code for applications in PHP and JavaScript,
• explanations and tips,
• links to related articles.

Tips for BeginnersTips for Beginners

Explore the sections Getting Started, How to Make Your First Request, and install the REST API Documentation app — it allows you to view documentation and make requests in the application console simultaneously.

Start with simple scenarios, such as filtering data in the tutorial How to Filter Elements by Stage Name. This tutorial does not use methods for modifying or deleting entities, ensuring that the data within the entities remains safe.

Here’s a sample algorithm for working with the section:

1. Select a category from the menu that interests you, such as CRM.
2. Find the tutorial that corresponds to your task.
3. Follow the step-by-step instructions and examples.
4. Adapt the code to your needs.
5. Check the results and ensure everything works.
6. Contact Bitrix24 support if you encounter any difficulties.

Categories of TutorialsCategories of Tutorials

CRM	How to work with CRM entities: contacts, deals, SPAs, custom fields, widgets, and Sales Intelligence
Online Sales and E-commerce	How to integrate sales functions: create product items, set up delivery, implement a cash register
Workflows	How to embed workflow actions, complete processes, configure Automation rules
Chatbots	How to create a chatbot, configure it for Open Channels, create a support channel
Telephony	How to implement custom scenarios for integration with a call center
Tasks	How to create tasks with files, attach them to SPAs, add comments
Open Channels	How to create a connector for online chat on a website and integrate it with Bitrix24

How to Provide Feedback on the TutorialsHow to Provide Feedback on the Tutorials

If you would like to add your scenario or improve an existing one:

• submit a pull request with your solution to the documentation repository,
• write an issue with your idea suggestion.