CRM Custom Activity Types: 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.
Applications can register custom activity types: upload a custom icon and specify the type name. For example, you can create your own activity type with an icon and name of your application.
Warning
Methods crm.activity.type.add, crm.activity.type.list, and crm.activity.type.delete work only within the context of an application and are available to the administrator. Calling them via an incoming webhook will return error Application context required.
Quick navigation: All Methods
User documentation: Timeline in CRM Item
Getting Started
- Prepare the name and icon for the activity type
- Register the type using the crm.activity.type.add method. If the type is required for configurable activities, pass
IS_CONFIGURABLE_TYPE = Y - Retrieve the list of registered types using the crm.activity.type.list method
- Delete the custom type using the crm.activity.type.delete method if it is no longer needed
Linking to Configurable Activities
A custom type with IS_CONFIGURABLE_TYPE = Y can be passed to the typeId field of the crm.activity.configurable.add method. If IS_CONFIGURABLE_TYPE = N, the type cannot be used for a configurable activity.
Types are linked to the application that registered them. The crm.activity.type.list method returns the types of the current application.
Overview of Methods
Scope:
crmWho can execute the method: administrator
|
Method |
Description |
|
Registers a custom activity type with a name and icon |
|
|
Retrieves a list of custom case types |
|
|
Deletes a custom type |