Bitrix24Install

Overview

This node integrates with the Bitrix24 CRM and business platform, allowing users to interact with various Bitrix24 resources programmatically. Specifically, for the Data Storage resource and the Get Entity Item Properties operation, it retrieves metadata about the properties (fields) of a specified entity item within Bitrix24.

Typical use cases include:

• Dynamically fetching available fields of CRM entities such as contacts, deals, leads, companies, quotes, invoices, or custom Smart Process Automation (SPA) entities.
• Using the retrieved field information to build dynamic forms or automate workflows that depend on entity structure.
• Validating or mapping data before creating or updating records in Bitrix24 by knowing which fields are available and their characteristics.

For example, a user might want to get all the fields of a "Deal" entity to understand what data can be set or extracted when automating sales processes.

Properties

Note: The provided input properties JSON only includes the Authentication property, but the node internally supports selecting Resource and Operation as well.

Output

The output is an array of objects representing the properties (fields) of the selected entity item. Each object typically contains:

• name: The display name or label of the field.
• value: The internal field identifier used in Bitrix24 API calls.
• description: A string describing the field type and whether it is required or read-only.

The fields are sorted by a custom order prioritizing common important fields (like TITLE, OPPORTUNITY, ASSIGNED_BY_ID) and then alphabetically.

If the node encounters an error while fetching fields, the output will contain an error message inside the json property.

The node does not output binary data.

Example output snippet (conceptual):

[
  {
    "name": "Title",
    "value": "TITLE",
    "description": "string (Required)"
  },
  {
    "name": "Opportunity",
    "value": "OPPORTUNITY",
    "description": "double"
  },
  {
    "name": "Assigned By",
    "value": "ASSIGNED_BY_ID",
    "description": "user ID"
  }
]

Dependencies

• Requires connection to Bitrix24 API via one of the supported authentication methods (OAuth2, webhook URL, or API key).
• Uses internal helper functions to make standard Bitrix24 API calls.
• No additional external services beyond Bitrix24 itself.
• Proper credentials must be configured in n8n for the chosen authentication method.

Troubleshooting

• Common issues:

  • Incorrect or expired authentication credentials leading to authorization errors.
  • Selecting an unsupported or invalid entity type/resource may result in empty or error responses.
  • Network connectivity problems preventing API calls.

• Error messages:

  • "Failed to load CRM fields: <error message>" indicates an issue retrieving fields from Bitrix24; check API permissions and network.
  • "No fields available" means the selected entity has no retrievable fields or the API returned no data.
  • If the node returns an error in the output JSON with a timestamp, it means the node was configured to continue on failure and caught an exception during execution.

• Resolution tips:

  • Verify authentication credentials and refresh tokens if using OAuth2.
  • Confirm the entity type parameter is correctly set.
  • Check Bitrix24 API limits and permissions.
  • Enable detailed logging in n8n to inspect API call responses.

Links and References

• Bitrix24 REST API Documentation
• Bitrix24 CRM Entities Overview
• n8n Documentation on Creating Custom Nodes