Actions20
Overview
This node interacts with custom user fields in Bitrix24 CRM entities, specifically for the "Lead" resource when using the "Get" operation. It allows retrieving detailed information about a specific custom user field by its ID. This is useful when you need to fetch metadata or configuration of a particular custom field associated with leads in Bitrix24.
Common scenarios include:
- Fetching details of a custom lead field to understand its properties before updating or using it.
- Integrating Bitrix24 lead custom fields into workflows where dynamic field data is required.
- Auditing or synchronizing custom field configurations between systems.
Example: You have a custom field on leads identified by a unique Field ID and want to retrieve its label, type, and other settings to display or process them in your automation.
Properties
| Name | Meaning |
|---|---|
| Field ID | The unique identifier of the custom user field to retrieve. Required for "get", "update", and "delete" operations. |
Output
The output JSON contains the response from the Bitrix24 API for the requested user field. It typically includes all metadata about the custom field such as:
- Field ID
- Field name and label
- User type (data type)
- Whether the field is mandatory or multiple
- Display options like filter visibility and list visibility
- Enumeration values if applicable
The exact structure depends on Bitrix24's API response but generally provides comprehensive details about the specified custom field.
No binary data output is produced by this node.
Dependencies
- Requires an active Bitrix24 API credential with webhook URL access.
- The node uses the Bitrix24 webhook URL to send POST requests to Bitrix24 REST API endpoints.
- No additional external services are needed beyond Bitrix24 itself.
Troubleshooting
- Missing Credentials: If no credentials or webhook URL are provided, the node will throw an error indicating these are required.
- Invalid Field ID: Providing an incorrect or non-existent Field ID will result in an API error from Bitrix24, which the node surfaces as an error message.
- API Errors: Network issues or permission problems with the Bitrix24 API may cause errors. The node reports these with messages prefixed by "Bitrix24 API error:" followed by the API's error description.
- Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error objects instead of stopping execution.
Links and References
- Bitrix24 REST API Documentation
- Bitrix24 Custom Fields Guide
- n8n documentation on creating custom nodes