Actions290
- Task Actions
- Direct API Actions
- CRM Actions
- User Actions
- SPA Actions
- Activity Actions
- Automation Actions
- Document Generator Actions
- Data Storage Actions
- Get Entity
- Add Entity
- Update Entity
- Delete Entity
- Get Entity Rights
- Get Entity Sections
- Add Entity Section
- Update Entity Section
- Delete Entity Section
- Get Entity Item
- Add Entity Item
- Update Entity Item
- Delete Entity Item
- Get Entity Item Properties
- Add Entity Item Property
- Update Entity Item Property
- Delete Entity Item Property
- Chat Actions
- User Field Actions
- File Actions
- User Field Config Actions
- Duplicate Actions
- Timeline Actions
- Disk Actions
- Upload File
- Download File
- Delete File
- Get File Info
- List Files
- Create Folder
- Delete Folder
- Get Storage Info
- Get Storages
- Get Storage
- Get Folders
- Get Folder
- Add Folder
- Update Folder
- Copy Folder
- Move Folder
- Rename Folder
- Get Files
- Get File
- Copy File
- Move File
- Rename File
- Share Item
- Get Shared Items
- Get Sharing Rights
- Update Sharing Rights
- Workflow Actions
- Status Actions
- Calendar Actions
- Chatbot Actions
- Events Actions
- Lists Actions
- Product Actions
- Open Lines Actions
- Telephony Actions
- Register External Call
- Finish External Call
- Hide External Call
- Show External Call
- Search CRM Entities
- Attach Call Record
- Get External Line
- Add External Line
- Update External Line
- Delete External Line
- Get Voximplant Statistics
- Get Voximplant Line
- Get Voximplant SIP Connector
- Get Voximplant SIP Line
- Add Voximplant SIP Line
- Update Voximplant SIP Line
- Delete Voximplant SIP Line
- Message Service Actions
- Notify Actions
Overview
This node integrates with the Bitrix24 CRM and business platform, specifically allowing users to add custom user field configurations to various entity types within Bitrix24. The "User Field Config - Add" operation enables creating new custom fields for entities such as Deals, Leads, Contacts, Companies, Quotes, Smart Processes, or Custom entities.
Typical use cases include:
- Extending Bitrix24 CRM entities with additional data fields tailored to specific business needs.
- Automating the creation of custom fields during onboarding or integration workflows.
- Managing CRM schema programmatically without manual UI configuration.
For example, a sales team might add a custom "Customer Priority" field to Deals to track priority levels directly in their CRM records.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating API requests: OAuth2 (recommended), Webhook URL (simpler but less secure), or API Key authentication. |
| Use Structure Builder | Boolean flag to choose between using a UI builder for field configuration (true) or inputting raw JSON configuration directly (false). |
| Entity Type | The type of CRM entity to which the user field will be added. Options: Deal, Lead, Contact, Company, Quote, Smart Process, Custom. |
| Custom Entity Type | If "Custom" is selected as Entity Type, specify the custom entity type string here. |
| Smart Process Type | When Entity Type is "Smart Process", select the specific Smart Process type. This ID is used in the field name format. |
| Field Name | The name of the custom field to create. A prefix (e.g., UF_CRM_) will be automatically added. |
| Field Type | Data type of the user field. Options include String, Integer, Double, Date, DateTime, Boolean, Enumeration, File, Employee, CRM Status. |
| Field Label | The display label for the custom field shown in the UI. |
| Field Settings | Collection of additional settings for the field: • Required (boolean): Whether the field must have a value. • Multiple (boolean): Allow multiple values. • Show Filter (None, Exact Match, Pattern Search). • Show in List (boolean): Display in list view. • Edit in List (boolean): Allow editing in list view. • List Items (JSON): Enumeration items if field type is enumeration. |
| Fields (JSON) | Raw JSON object defining the user field configuration. Used when not using the structure builder UI. |
| Options | Additional options collection, e.g., Access Token for authentication (if applicable). |
Output
The node outputs an array of items where each item contains a json property representing the response from Bitrix24 after attempting to add the user field configuration. The exact structure depends on the Bitrix24 API response but typically includes details about the created field or error information.
If the operation fails and "Continue On Fail" is enabled, the output will contain an error object with keys:
error: Error message string.resource: The resource name ("userFieldConfig").timestamp: ISO timestamp of the error occurrence.
No binary data output is produced by this node.
Dependencies
- Requires valid authentication credentials for Bitrix24 via one of the supported methods: OAuth2, Webhook URL, or API Key.
- The node relies on Bitrix24's REST API endpoints to perform operations.
- No additional external services are required beyond Bitrix24.
- Proper configuration of authentication credentials in n8n is necessary.
Troubleshooting
Common Issues:
- Invalid or expired authentication tokens leading to authorization errors.
- Incorrect field names or types causing API validation failures.
- Missing required parameters like Entity Type or Field Name.
- Improperly formatted JSON when using the raw JSON input option.
Error Messages:
- Authorization errors: Check that the API key, OAuth token, or webhook URL is correct and has sufficient permissions.
- Validation errors from Bitrix24 API: Review the field configuration parameters for correctness.
- Network or connectivity issues: Ensure n8n can reach Bitrix24 endpoints.
Resolutions:
- Re-authenticate or refresh credentials.
- Validate JSON syntax carefully if using raw JSON input.
- Use the structure builder UI option to reduce configuration errors.
- Enable "Continue On Fail" to handle errors gracefully in workflows.