Tutorials: Ready-to-Use REST API Scenarios

Tutorials are a practical guide for developers working with the Bitrix24 REST API. Tutorials help solve common tasks: creating or modifying items, and configuring integrations with external systems.

How to Use TutorialsHow to Use Tutorials

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

• As templates for real-world scenarios. Tutorials can be used as a foundation for your own solutions: adapt the examples to your needs, and add error handling logic and logging. For example, the How to Implement a Simple Cash Register via REST API tutorial.

• For quickly solving specific tasks. Tutorials help you find ready-to-use code examples. For example, the How to Configure Rounding for a Custom Numeric Field tutorial.

Tutorial StructureTutorial Structure

Tutorials consist of:

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

Tips for BeginnersTips for Beginners

Study the Getting Started and How to Make Your First Request sections to learn the basics of working with the Bitrix24 REST API.

Start with simple scenarios, such as filtering data in the How to Filter Items by Stage Name tutorial. It does not use methods to modify or delete items, so the data within the items will remain safe.

Example workflow for working with a section:

1. Select a category of interest from the menu, 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. Verify the result and ensure everything works correctly.
6. Contact Bitrix24 Helpdesk if you encounter any difficulties.

Tutorial CategoriesTutorial Categories

CRM	How to work with CRM objects: contacts, deals, smart processes, custom fields, widgets, and Sales Intelligence
Online sales and Online store	How to integrate trading functions: create product items, set up delivery, implement a cash register
Product catalog	How to create products, properties, prices, and other catalog data
Business processes	How to embed an action, complete processes, configure robot parameters
Chatbots	How to create a chatbot, configure it for Open Channels, and 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 smart processes, and add comments
Open Channels	How to create a connector for an online chat on a website and integrate it with Bitrix24

How to Provide Feedback on TutorialsHow to Provide Feedback on Tutorials

If you want to add your own scenario or improve an existing one, you can submit Pull Requests and Issues.