Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Actions290

Overview

This node integrates with the Bitrix24 platform, specifically allowing users to interact with various Bitrix24 resources such as CRM entities and user fields. The "Get User Field Settings" operation under the "User Field" resource retrieves configuration details about custom user fields defined in Bitrix24.

Typical use cases include:

  • Fetching metadata about custom fields for CRM entities or Smart Process Automation (SPA) entities.
  • Dynamically loading field configurations to build forms or validate data before sending it to Bitrix24.
  • Automating synchronization or reporting tasks that depend on user field definitions.

For example, a user might want to retrieve all custom fields configured for contacts to display them in an external application or to prepare data import templates.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24. Options: OAuth2 (recommended), Webhook (simpler), API Key.
Options Additional options collection containing:
- Access Token String token used for authentication when applicable (e.g., OAuth2 access token).

Output

The node outputs an array of items where each item contains a json object representing the result of the requested operation.

For the "Get User Field Settings" operation, the output JSON typically includes detailed configuration information about user fields, such as:

  • Field identifiers
  • Labels (form label, list column label, filter label)
  • Field types
  • Flags indicating if the field is mandatory, multiple, searchable, editable, etc.
  • Sorting order and external IDs

If an error occurs and "Continue On Fail" is enabled, the output will contain an error object with the message, resource name, and timestamp.

No binary data output is indicated by the source code.

Dependencies

  • Requires connection to Bitrix24 API via one of the supported authentication methods (OAuth2, webhook URL, or API key).
  • Needs proper credentials configured in n8n corresponding to the chosen authentication method.
  • Uses internal helper functions to make standard Bitrix24 API calls.
  • No additional external libraries beyond those bundled with the node are required.

Troubleshooting

  • Common Issues:

    • Authentication failures due to invalid or expired tokens.
    • API rate limits or permission errors from Bitrix24.
    • Missing or incorrect resource/operation parameters.
    • Network connectivity issues.
  • Error Messages:

    • Errors thrown during API calls will be surfaced with their messages.
    • If "Continue On Fail" is enabled, errors are returned as part of the output JSON with an error field.
    • Loading options or fields may return descriptive error entries if the API response is malformed or empty.
  • Resolutions:

    • Verify and refresh authentication credentials.
    • Ensure the Bitrix24 account has sufficient permissions.
    • Double-check input parameters for correctness.
    • Check network connectivity and proxy settings if applicable.

Links and References

Discussion