Actions31
- Company Actions
- Contact Actions
- Deal Actions
- Item Actions
- Lead Actions
- User Custom Method Actions
Overview
This node integrates with the Bitrix24 REST API, specifically targeting CRM resources such as Deals. The "Get Fields Description" operation for the Deal resource retrieves metadata about the fields available in a Deal entity within Bitrix24. This is useful for dynamically understanding what data can be accessed or manipulated in Deals, enabling users to build workflows that adapt to the current CRM schema.
Common scenarios include:
- Fetching field definitions to dynamically generate forms or UI elements.
- Validating input data against the available Deal fields before creating or updating records.
- Synchronizing external systems by mapping their data fields to Bitrix24 Deal fields.
For example, a user might use this node to get all Deal fields and then use that information to populate dropdowns in a custom app or to ensure that data being sent to Bitrix24 matches the expected structure.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating with Bitrix24 API. Options: - OAuth2 - Webhook |
| resourceCategory | (Hidden) Automatically derived category from the selected resource, e.g., "crm" |
Output
The node outputs JSON data containing the description of the fields for the Deal resource. This typically includes field names, types, labels, and possibly other metadata describing each field's characteristics in Bitrix24.
No binary data output is involved in this operation.
Dependencies
- Requires authentication credentials for Bitrix24, either via OAuth2 or Webhook method.
- Needs proper configuration of these credentials in n8n to access the Bitrix24 REST API.
- Relies on Bitrix24 API availability and permissions granted to the authenticated user.
Troubleshooting
- Authentication errors: Ensure that the provided OAuth2 token or webhook URL is valid and has sufficient permissions to access CRM Deal data.
- API rate limits or connectivity issues: Bitrix24 may throttle requests; verify network connectivity and API usage limits.
- Unexpected empty or incomplete field descriptions: Check if the authenticated user has access rights to view Deal fields or if the Bitrix24 instance has customized fields that require additional permissions.
- Invalid resource or operation selection: Confirm that the resource is set to "Deal" and the operation to "Get Fields Description" to avoid mismatches.