Configurable CRM Activities: Methods Overview

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.

Configurable activities are CRM activities created by an application. An application configures the appearance of the activity card, timeline blocks, buttons, and badges.

Warning

Methods crm.activity.configurable.add, crm.activity.configurable.update, and crm.activity.configurable.get work only within the context of an application. Calling them via an incoming webhook will return error ERROR_WRONG_CONTEXT.

Quick navigation: All Methods

Getting Started

  1. Prepare the application from which the methods will be called and obtain an OAuth token
  2. Create a configurable activity using the crm.activity.configurable.add method. If a custom activity type is required, first register it using the crm.activity.type.add method with the IS_CONFIGURABLE_TYPE = Y field
  3. Update the structure or data of an activity using the crm.activity.configurable.update method
  4. Retrieve an activity by ID using the crm.activity.configurable.get method
  5. Find configurable activities using the crm.activity.list method with the PROVIDER_ID = CONFIGURABLE_REST_APP filter
  6. Delete an activity using the crm.activity.delete method

Relationships with Other Sections

Custom Activity Types. The crm.activity.type.add, crm.activity.type.list, and crm.activity.type.delete methods manage the types that can be passed to the typeId field of a configurable activity. For typeId, different from CONFIGURABLE, the type must be created by the same application with IS_CONFIGURABLE_TYPE = Y.

Card Structure. The Configurable Activity Structure section describes layout: the icon, heading, body, footer, and actions within the card.

Badges. The Configurable Activity Badges section describes the badge codes that can be passed to the badgeCode field.

Additional

Overview of Methods

Scope: crm

Who can execute the method: any user

Method

Description

crm.activity.configurable.add

Adds a new configurable activity to the timeline

crm.activity.configurable.update

Updates a configurable activity

crm.activity.configurable.get

Retrieves information about the activity

crm.activity.delete

Deletes a configurable activity by its identifier

crm.activity.list

Retrieves a list of all configurable activities for a CRM entity filtered by PROVIDER_ID = CONFIGURABLE_REST_APP
Previous
Get Communication Description
Next
Structure of a Configurable Activity