Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

This node interacts with the Bitrix24 CRM and business platform, specifically allowing users to retrieve configurations of user fields within Bitrix24. The "User Field Config" resource with the "Get" operation fetches detailed information about a specific user field configuration by its ID, optionally scoped to a particular entity type (like DEAL, LEAD, CONTACT, or Smart Process entities).

Common scenarios for this node include:

  • Retrieving metadata about custom fields configured in Bitrix24 CRM entities.
  • Automating workflows that depend on dynamic field configurations.
  • Integrating Bitrix24 user field settings into external systems or reports.

For example, a user might use this node to get the configuration details of a custom field on a Deal entity to understand its properties before updating or using it in further automation.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24: OAuth2 (recommended), Webhook URL (simpler but less secure), or API Key authentication.
ID The unique identifier of the user field configuration to retrieve. This is required.
Entity ID Optional. Specifies the entity type the user field belongs to, e.g., DEAL, LEAD, CONTACT, or CRM_7 for Smart Process entities. For Smart Process, use the format CRM_[ID].
Options Additional options collection; currently includes:
   Access Token An access token string used for authentication if applicable.

Output

The node outputs an array of items where each item contains a json object representing the retrieved user field configuration data from Bitrix24. The exact structure depends on the Bitrix24 API response for the user field config but typically includes field metadata such as field name, type, labels, settings, and other configuration details.

If an error occurs and the node is set to continue on failure, the output will contain an item with an error property describing the issue, along with the resource name and a timestamp.

The node does not output binary data.

Dependencies

  • Requires connection to Bitrix24 via one of the supported authentication methods:
    • OAuth2 authentication (recommended for production).
    • Bitrix24 webhook URL.
    • Bitrix24 API key.
  • Proper credentials must be configured in n8n corresponding to the chosen authentication method.
  • Network access to Bitrix24 API endpoints is necessary.

Troubleshooting

  • Common issues:

    • Invalid or expired authentication tokens can cause authorization failures.
    • Incorrect or missing User Field Configuration ID will result in errors or empty responses.
    • Specifying an invalid or unsupported Entity ID may lead to no results or API errors.
    • Network connectivity problems can prevent API calls from succeeding.

  • Error messages:

    • Errors returned from Bitrix24 API are surfaced in the error field of the output when "Continue On Fail" is enabled.
    • Typical error messages include authentication failures, invalid parameters, or rate limiting.

  • Resolutions:

    • Verify that the authentication credentials are valid and have sufficient permissions.
    • Double-check the User Field Configuration ID and Entity ID values.
    • Ensure network connectivity and that Bitrix24 API endpoints are reachable.
    • If using webhooks, confirm the webhook URL is correct and active.

Links and References

Discussion