Actions89
- Direct API Actions
- CRM Actions
- Task Actions
- User Actions
- SPA Actions
- Activity Actions
- Automation Actions
- Document Generator Actions
- Data Storage Actions
- Chat Actions
Overview
The Bitrix24 node enables interaction with the Bitrix24 CRM and business platform. Specifically, for the Data Storage resource with the Get Fields operation, it retrieves metadata about fields available in a specified Bitrix24 entity type (such as contacts, deals, leads, companies, etc.). This is useful when you want to dynamically fetch field definitions to understand what data can be accessed or manipulated within Bitrix24 entities.
Common scenarios include:
- Dynamically populating UI elements with available fields for a selected entity.
- Validating or mapping data fields before performing create/update operations.
- Building integrations that adapt to custom fields configured in Bitrix24.
Example: Fetching all available fields of the "Contact" entity to display them in a dropdown for further processing or filtering.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method to authenticate with Bitrix24. Options: OAuth2 (recommended), Webhook (simpler), API Key. |
| Options | Collection of optional parameters (only shown for some resources): |
| - Access Token | String token used for authentication (if applicable). |
| - Filter | JSON object specifying filter criteria to narrow down results. |
| - Select | Comma-separated string listing specific fields to retrieve. |
| - Order | JSON object defining ordering criteria for returned fields. |
| - Start | Number indicating the start position for pagination of results. |
Note: The provided properties JSON shows these options are conditionally displayed based on the resource selected.
Output
The node outputs an array of items where each item's json property contains the retrieved data from Bitrix24. For the "Get Fields" operation, this typically includes:
- A list of field definitions for the specified entity/resource.
- Each field definition includes attributes such as field ID, name, type, whether it is required, and descriptive labels.
If an error occurs during execution, the output will contain an item with an error message, the resource name, and a timestamp.
No binary data output is indicated by the source code.
Dependencies
- Requires valid authentication credentials for Bitrix24 via one of the supported methods (OAuth2, webhook URL, or API key).
- Uses Bitrix24 API endpoints internally to fetch field metadata.
- No additional external dependencies beyond standard HTTP calls to Bitrix24 APIs.
- Proper configuration of credentials in n8n is necessary for successful API communication.
Troubleshooting
- Authentication errors: Ensure the chosen authentication method is correctly configured and tokens/keys are valid.
- Empty or missing fields: Verify the entity type parameter is correctly set and that the Bitrix24 account has access to the requested entity.
- API rate limits or connectivity issues: Network problems or Bitrix24 API limits may cause failures; retry or check API usage.
- Error messages in output: The node returns error details in the output JSON if
continueOnFailis enabled; otherwise, it throws exceptions. - Incorrect or malformed filter/order JSON: Filters and order criteria must be valid JSON objects; invalid syntax will cause API call failures.