Bitrix24 User Field

Overview

This node interacts with custom user fields in Bitrix24 CRM entities such as Deals, Leads, Contacts, and Companies. Specifically for the Deal resource and the Get operation, it retrieves detailed information about a specific custom user field by its ID.

Common scenarios where this node is useful include:

• Fetching metadata of a custom field to understand its configuration or display properties.
• Validating the existence and details of a user field before performing updates or other operations.
• Integrating Bitrix24 custom field data into workflows that require dynamic field information.

For example, you might use this node to get the label, type, and options of a custom field on a Deal to dynamically generate forms or reports based on current CRM configurations.

Properties

Output

The output JSON contains the response from the Bitrix24 API for the requested user field. It typically includes all metadata related to the custom field such as:

• Field ID
• Field name and label
• User type (data type)
• Whether the field supports multiple values
• Mandatory status
• Visibility settings (filter, list)
• Enumeration values if applicable

The node does not output binary data.

Example output structure (simplified):

{
  "result": {
    "ID": "123",
    "FIELD_NAME": "UF_CRM_DEAL_CUSTOM",
    "EDIT_FORM_LABEL": "Custom Deal Field",
    "USER_TYPE_ID": "string",
    "MULTIPLE": "N",
    "MANDATORY": "N",
    "SHOW_FILTER": "Y",
    "SHOW_IN_LIST": "Y",
    "LIST": []
  }
}

Dependencies

• Requires an active Bitrix24 API webhook URL credential configured in n8n.
• Uses HTTP POST requests to Bitrix24 REST API endpoints.
• The node expects the webhook URL to be provided via credentials.
• Optionally sets the default language environment variable based on credential data.

Troubleshooting

• No credentials got returned!: Ensure that the Bitrix24 API credential is properly set up and connected.
• Webhook URL is required!: The credential must include a valid webhook URL; verify your Bitrix24 webhook configuration.
• Bitrix24 API error: [error message]: Indicates an error response from Bitrix24 API. Check the error message for details such as invalid field ID or permission issues.
• If the node returns an error object in the output, enabling "Continue On Fail" can help process multiple items without stopping the workflow.
• Network or authentication errors may occur if the webhook URL is incorrect or expired.

Links and References

• Bitrix24 REST API Documentation
• Bitrix24 Custom Fields Guide
• n8n documentation on creating custom nodes