How to Make Your First API Request

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

To make your first request to the REST API, create an incoming webhook. This is a ready-to-use tool for calling API methods with the permissions of the user who created the webhook.

On this page, you will learn how to configure a webhook, perform a test request, and choose the appropriate authorization method for your integration.

How to Create an Incoming Webhook

  1. In the Bitrix24 left menu, open the Applications > Developer resources section.
  2. Go to the Scenarios > Other > Incoming webhook tab. A slider will appear containing the pre-generated webhook code.

Never share the secret webhook code and do not embed it in public web page code or scripts.

Request Generator

Below the webhook code is the Request Generator block. You can use it to select the required method and parameter values.

  1. Select a method from the list. If the required method is not in the list:

    • Set the necessary scopes in the Permission settings block and save the webhook.
    • Manually enter the method name in the URL.

    Query Generator

  2. Specify the method parameters if necessary.

  3. Click the Execute button. The request will be sent to the Bitrix24 API, and you will see the response in JSON format.

    JSON response

Webhook URL Structure

To execute a request from an external system, a URL is used which is generated automatically. You can view it in the generator.

Example URL:

https://test.bitrix24.com/rest/1/4l777m8lapmdaz1n/crm.company.add.json?fields[TITLE]=Company

The URL consists of several parts:

  • test.bitrix24.com — your Bitrix24 address
  • /rest — indication of REST API access
  • /1 — the identifier of the user who created the webhook
  • /4l777m8lapmdaz1n — the unique webhook code
  • /crm.company.add — the called Bitrix24 REST API method
  • .json — the data format
  • ?fields — parameters required for the specific method

Permission Settings

The Permission settings block specifies which Bitrix24 modules the webhook can access. Requests are executed with the permissions of the user who created the webhook and only within the selected scopes. You can find out which scopes are required to execute a specific method on its description page.

Other Ways to Work with the API

Incoming webhooks are suitable for personal use and internal scenarios where requests are executed on behalf of a single user. For local applications that will run for different users, use OAuth 2.0. For commercial solutions that will be listed in the Bitrix24 Market, OAuth 2.0 and solution registration are also required.

  • To register local applications, go to the Scenarios > Other > Local application tab.
  • To list solutions in the Market, you must become a partner program member. To do this, fill out the application form on the developer portal website.
Previous
How to Access the REST API
Next
How to Use Examples