Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

This node integrates with the Bitrix24 platform, specifically allowing users to interact with various Bitrix24 resources and operations. For the User Field Config resource with the Get List operation, it retrieves a list of user field configurations from Bitrix24. This is useful for scenarios where you need to programmatically access metadata about custom fields defined in Bitrix24 entities, such as CRM contacts or deals.

Practical examples include:

  • Synchronizing custom field definitions between Bitrix24 and another system.
  • Dynamically generating forms or reports based on available user fields.
  • Auditing or exporting field configuration details for compliance or documentation.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24: OAuth2 (recommended), Webhook (simpler), or API Key
Filter JSON string defining filter criteria to narrow down which user field configs to retrieve
Order JSON string specifying sort order for the results
Select Comma-separated list of specific fields to select from the user field config records
Start Numeric offset for pagination, indicating where to start retrieving records
Options Additional options collection; currently supports providing an Access Token string

Output

The node outputs an array of items where each item's json property contains the retrieved user field configuration data from Bitrix24. The structure corresponds to the fields returned by the Bitrix24 API for user field configurations, including properties like field ID, name, type, labels, and settings.

If the node encounters an error and "Continue On Fail" is enabled, it outputs an item with an error field describing the issue, along with the resource name and a timestamp.

No binary data output is indicated for this operation.

Dependencies

  • Requires connection to Bitrix24 via one of the supported authentication methods: OAuth2, webhook URL, or API key.
  • Needs appropriate credentials configured in n8n for the chosen authentication method.
  • Relies on Bitrix24 API endpoints to fetch user field configuration data.
  • No additional external libraries beyond those bundled with the node are required.

Troubleshooting

  • Common issues:

    • Incorrect or expired authentication credentials leading to authorization errors.
    • Malformed JSON in the Filter or Order properties causing API request failures.
    • Pagination parameters (Start) set incorrectly, resulting in missing or repeated data.
    • Network connectivity problems preventing API calls.

  • Error messages:

    • Errors thrown by the Bitrix24 API will be surfaced in the node's output if "Continue On Fail" is enabled.
    • Typical messages may include authentication failures, invalid filter syntax, or rate limiting notices.

  • Resolutions:

    • Verify and refresh authentication credentials.
    • Ensure JSON strings for filters and ordering are valid and correctly formatted.
    • Adjust pagination offsets carefully.
    • Check network access and Bitrix24 service status.

Links and References

Discussion