Local Integrations: Use Case Scenarios

A scenario describes a practical task and the sequence of methods required to perform it. In local integrations, scenarios demonstrate how to pass data to the CRM, create a task with an attachment, embed an application interface, and configure a chatbot.

Quick links: All Scenarios

User documentation: Create webhooks and apps in Bitrix24

Connection with Other ObjectsConnection with Other Objects

Scenarios are linked to CRM objects, tasks, Drive files, the Bitrix24 interface, and chats.

• CRM. Data from an external form can be retained in a contact using the crm.contact.add method. To migrate existing data, use the crm.item.import and crm.item.batchImport methods.
• Tasks and Drive Files. A file is first uploaded using the disk.folder.uploadfile method, and then its identifier is passed when creating a task using the tasks.task.add method.
• Bitrix24 Interface. A widget opens an application page within a CRM card. To register a handler, use the placement.bind method. This method works only within the context of an application.
• Chats and Chatbots. A chatbot is registered using the imbot.v2.Bot.register method. To receive events, you can configure periodic polling or specify a handler URL. The imbot.v2 methods are available via an incoming webhook or a local application.

For more details on these tools, read the Incoming and Outgoing Webhooks and Local Applications articles.

Getting StartedGetting Started

1. Define the integration task.
2. Select a scenario and tool in the table.
3. Verify the scope of the methods and the permissions of the user on whose behalf the integration performs requests.
4. Prepare the data and identifiers. If Bitrix24 needs to open an application page or send an event to it, prepare a handler—a page with a URL accessible from an external network.
5. Execute the methods in the specified order and verify the result.

How to Choose a ScenarioHow to Choose a Scenario

If needed	Tool	Open
Transfer contacts from a website web form to CRM	Incoming webhook or local application	Add contact via web form
Add application interface to a CRM card	Local application	How to embed widgets into CRM
Migrate existing data to CRM	Incoming webhook or local application	Data import to CRM: methods overview
Create a task and attach a file to it	Incoming webhook or local application	How to create a task with an attached file
Create a chatbot for Bitrix24	Incoming webhook or local application	Chatbots 2.0: quick start