Bitrix24Install

Overview

The Bitrix24 node enables interaction with the Bitrix24 CRM and business platform, specifically supporting various resources including Smart Process Automation (SPA). The "Get Fields" operation under the SPA resource fetches metadata about the fields available for a selected Smart Process type. This is useful when you want to dynamically retrieve field definitions to build forms, validate data, or automate workflows based on the structure of a specific SPA entity.

Typical use cases include:

• Dynamically populating UI elements with field options from a SPA type.
• Validating input data against the required and available fields of a SPA type.
• Automating processes that depend on the schema of SPA entities in Bitrix24.

For example, if you have a custom SPA type representing customer requests, you can use this node operation to get all the fields defined for that type, including their labels and whether they are required, which helps in building integrations or automations that handle those requests.

Properties

Output

The output JSON contains an array of objects representing the fields of the selected SPA type. Each object includes:

• name: The display label of the field (e.g., "Title", "Status").
• value: The internal field ID used in Bitrix24 API calls.
• description: A string describing the field type and attributes such as whether it is required or read-only.

Example snippet of output JSON items:

[
  {
    "name": "Title",
    "value": "TITLE",
    "description": "string (Required)"
  },
  {
    "name": "Status",
    "value": "STATUS_ID",
    "description": "list"
  }
]

This structured output allows downstream nodes or workflows to understand the schema of the SPA entity and act accordingly.

The node does not output binary data for this operation.

Dependencies

• Requires a valid Bitrix24 account with access to the CRM and Smart Process features.
• Requires one of the supported authentication methods configured in n8n:
  • OAuth2 credentials for Bitrix24.
  • Webhook URL for Bitrix24.
  • API key credential for Bitrix24.
• The node internally uses Bitrix24 REST API endpoints such as crm.item.fields and crm.type.list to fetch SPA types and fields.

Troubleshooting

• Common issues:

  • Failure to load SPA types or fields often results from incorrect or insufficient permissions in the Bitrix24 account.
  • Network connectivity problems or invalid authentication credentials will cause API call failures.
  • Selecting an invalid or empty Type ID will result in no fields being returned.

• Error messages:

  • "Failed to load SPA fields: <error message>" indicates an issue fetching fields from Bitrix24. Verify API credentials and permissions.
  • "Please select a Type first" means the Type ID parameter was not set before attempting to load fields.
  • "No fields available" means the selected SPA type has no fields or the API response was empty.

• Resolution tips:

  • Ensure the authentication method is correctly configured and authorized.
  • Confirm the selected SPA Type ID exists and is accessible.
  • Check Bitrix24 user permissions for accessing SPA metadata.
  • Review network logs and API responses for more detailed error information.

Links and References

• Bitrix24 REST API Documentation
• Bitrix24 Smart Process Automation Overview
• n8n Documentation on Credentials