Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

This node integrates with the Bitrix24 platform, allowing users to interact with various Bitrix24 resources such as CRM entities and business processes. Specifically, for the User resource with the Get User Fields operation, it retrieves metadata about user fields configured in Bitrix24. This can be useful for dynamically fetching available user field definitions to build forms, filters, or data mappings in workflows.

Common scenarios include:

  • Automatically loading user field configurations to customize data input forms.
  • Fetching user field metadata to validate or transform user-related data before processing.
  • Integrating Bitrix24 user data into other systems by understanding the structure of user fields.

Example: A workflow that needs to display a list of all custom and standard user fields to allow an end-user to select which fields to update or query.

Properties

Name Meaning
Authentication Method to authenticate with Bitrix24. Options: OAuth2 (recommended), Webhook (simpler), API Key.
Options Collection of optional parameters:
- Filter JSON object specifying filter criteria to narrow down user fields.
- Order JSON object specifying sorting order of returned fields.
- Admin Mode Boolean flag indicating whether to use admin mode for the request.
- Custom Parameters Additional JSON parameters to pass to the API call for extended customization.

Output

The node outputs an array of items where each item contains a json object representing user field metadata retrieved from Bitrix24. The structure typically includes:

  • Field identifiers (e.g., ID, FIELD_NAME).
  • Labels used in forms and lists (e.g., EDIT_FORM_LABEL, LIST_COLUMN_LABEL).
  • Field properties such as type, mandatory status, multiple values allowed, visibility in lists, editability, searchability, and sort order.
  • Additional settings or external IDs if applicable.

If binary data were involved (not in this operation), it would represent file attachments or media related to user fields, but this operation focuses on JSON metadata only.

Dependencies

  • Requires connection to Bitrix24 via one of the supported authentication methods: OAuth2, webhook URL, or API key.
  • Needs proper credentials configured in n8n for the chosen authentication method.
  • Relies on Bitrix24 API endpoints to fetch user field configurations.
  • Uses internal helper functions to make standardized API calls to Bitrix24.

Troubleshooting

  • Authentication errors: Ensure the selected authentication method is correctly configured with valid credentials. OAuth2 tokens may expire and require refresh.
  • API call failures: Check network connectivity and Bitrix24 API availability. Verify that the user account has sufficient permissions, especially if using admin mode.
  • Invalid JSON in options: The Filter, Order, and Custom Parameters fields expect valid JSON. Malformed JSON will cause parsing errors.
  • Empty results: If no user fields are returned, verify that the Bitrix24 instance actually has user fields configured and that any filters applied do not exclude all fields.
  • Continue on Fail: If enabled, the node returns error details in the output JSON instead of failing the entire workflow, useful for debugging.

Links and References

Discussion