Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Actions290

Overview

This node interacts with the Bitrix24 platform, specifically to retrieve user field configurations when using the "User Field" resource and the "Get User Fields" operation. It is designed to fetch metadata about custom or system fields defined in Bitrix24 entities, which can be useful for dynamically understanding the structure of data within Bitrix24 CRM or other modules.

Common scenarios where this node is beneficial include:

  • Dynamically loading available user fields to build forms or UI elements.
  • Synchronizing field metadata between Bitrix24 and external systems.
  • Automating workflows that depend on specific user field configurations.

For example, a user might use this node to get all custom fields defined for contacts or deals in Bitrix24 before creating or updating records programmatically.

Properties

Name Meaning
Authentication Method to authenticate with Bitrix24. Options: OAuth2 (recommended), Webhook (simpler), API Key
Options Additional options collection; currently supports: Access Token (string) used for authentication

Output

The node outputs an array of items where each item's json property contains the user field data retrieved from Bitrix24. The exact structure depends on the Bitrix24 API response but generally includes details such as:

  • Field identifiers
  • Field names and labels
  • Field types
  • Whether the field is required or read-only
  • Other metadata relevant to user fields

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

The node does not output binary data.

Dependencies

  • Requires access to a Bitrix24 account with appropriate permissions.
  • Needs one of the following authentication methods configured in n8n:
    • OAuth2 credentials (recommended for production)
    • Webhook URL (simpler but less secure)
    • API key authentication
  • Uses Bitrix24 REST API endpoints internally to fetch user field information.

Troubleshooting

  • Authentication errors: Ensure the selected authentication method is correctly configured and valid. For OAuth2, verify token validity and scopes. For webhook or API key, confirm the credentials are correct.
  • API call failures: Network issues or insufficient permissions may cause API calls to fail. Check connectivity and user rights in Bitrix24.
  • Empty or missing fields: If no user fields are returned, verify that the target Bitrix24 entity actually has custom fields defined.
  • Error messages in output: When "Continue On Fail" is enabled, errors are returned in the output JSON. Review the error message for clues and adjust configuration accordingly.

Links and References

Discussion