Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

This node interacts with Bitrix24, a CRM and business platform, to perform various operations on its resources. Specifically, the "Lists" resource with the "Get Element Fields" operation retrieves metadata about the fields of a specified list (also known as an information block or iblock) in Bitrix24. This is useful when you want to dynamically understand the structure of a list before performing further actions like querying elements or updating data.

Common scenarios include:

  • Fetching the schema of a Bitrix24 list to build dynamic forms or UI components.
  • Validating field names before creating or updating list elements.
  • Automating workflows that depend on the list's field definitions.

Example: Before adding new entries to a Bitrix24 list, you can use this operation to get all available fields and their properties, ensuring your data matches the expected format.

Properties

Name Meaning
Authentication Method to authenticate with Bitrix24. Options: OAuth2 (recommended for production), Webhook (simpler but less secure), API Key authentication.
List ID The identifier of the Bitrix24 list (information block) whose element fields you want to retrieve.
Options Additional optional parameters:
- Access Token: Use a specific access token instead of credentials.
- Filter: JSON object to filter results.
- Order: JSON object specifying sort order.
- Select: Comma-separated list of fields to select.

Output

The output is a JSON array describing the fields of the specified Bitrix24 list. Each item in the array typically includes:

  • Field name (ID)
  • Display label or title
  • Type information (e.g., string, integer)
  • Flags such as whether the field is required or read-only
  • Additional metadata useful for understanding how to interact with each field

If the node supports binary data output, it is not relevant for this operation since it only fetches metadata.

Dependencies

  • Requires connection to a Bitrix24 instance.
  • Needs one of the supported authentication methods configured: OAuth2, Webhook URL, or API Key.
  • The node internally uses Bitrix24 API calls to fetch field information.
  • No additional external services are required beyond Bitrix24 itself.

Troubleshooting

  • Common issues:

    • Invalid or missing List ID: Ensure the List ID corresponds to an existing list in Bitrix24.
    • Authentication failures: Verify that the chosen authentication method is correctly set up and tokens/keys are valid.
    • API rate limits or connectivity problems with Bitrix24 may cause errors.

  • Error messages:

    • Errors related to loading fields often indicate network issues or incorrect permissions.
    • If the node returns an error message about failing to load fields, check the API credentials and ensure the user has access rights to the specified list.
    • JSON parsing errors in filter/order options may occur if invalid JSON is provided.

Links and References

Discussion