Bitrix24

Overview

This node interacts with the Bitrix24 platform, specifically supporting operations on various resources including Smart Process Automation (SPA) entities. The "Get Fields" operation for the SPA resource retrieves metadata about the fields available in a selected Smart Process type. This is useful when you want to dynamically understand or display the structure of SPA items before creating, updating, or processing them.

Common scenarios include:

• Dynamically generating forms or UI elements based on SPA field definitions.
• Validating input data against the required and available fields of a SPA type.
• Automating workflows that depend on specific SPA fields.

For example, if you have a custom SPA type representing customer requests, you can use this node to fetch all its fields and then map incoming data accordingly.

Properties

Output

The node outputs an array of objects representing the fields of the selected SPA type. Each object typically contains:

• name: The display name or label of the field.
• value: The internal field ID used by Bitrix24.
• description: Additional information about the field such as its data type, whether it is required, or read-only status.

Example output JSON snippet:

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

No binary data output is produced by this operation.

Dependencies

• Requires connection to Bitrix24 via one of the supported authentication methods (OAuth2, webhook URL, or API key).
• The node relies on Bitrix24's REST API endpoint crm.item.fields with the parameter entityTypeId set to the selected SPA type ID.
• Proper permissions in Bitrix24 are necessary to access SPA metadata.

Troubleshooting

• Error loading fields: If the node returns an error message indicating failure to load fields, verify that the provided SPA Type ID is correct and that the API credentials have sufficient permissions.
• No fields available: This may indicate that the selected SPA type has no defined fields or the API response was empty. Confirm the SPA type exists and contains fields.
• Authentication errors: Ensure the chosen authentication method is correctly configured in n8n and valid at runtime.
• Empty Type ID: The "Type ID" property is required; leaving it empty will prevent the node from fetching fields.

Links and References

• Bitrix24 REST API Documentation
• Bitrix24 Smart Process Automation Overview
• n8n Documentation on Creating Custom Nodes