Actions31
- Company Actions
- Contact Actions
- Deal Actions
- Item Actions
- Lead Actions
- User Custom Method Actions
Overview
This node integrates with the Bitrix24 REST API, allowing users to interact with various CRM resources such as Contacts, Companies, Deals, Leads, and Items. Specifically, for the "Contact" resource and the "Get Fields Description" operation, the node retrieves metadata describing the fields available for contacts in Bitrix24. This can be useful for dynamically understanding the structure of contact data, building forms, or validating input before creating or updating contacts.
Common scenarios include:
- Fetching field definitions to build dynamic user interfaces.
- Validating data against the expected contact fields.
- Automating workflows that depend on contact field metadata.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method used to authenticate with Bitrix24 API. Options: - OAuth2 - Webhook |
The property resourceCategory is hidden and automatically derived from the selected resource; it is not directly set by the user.
Output
The node outputs JSON data containing the description of the fields for the Contact resource. This typically includes field names, types, labels, and other metadata that describe each contact field available in Bitrix24.
If the node supports binary data output (not indicated here), it would represent any file or media content returned by the API, but this operation primarily returns structured JSON metadata.
Dependencies
- Requires a valid Bitrix24 API authentication credential, either via OAuth2 or Webhook method.
- The node depends on Bitrix24 REST API availability.
- No additional external dependencies are indicated.
Troubleshooting
- Authentication errors: Ensure the provided API credentials are valid and have sufficient permissions to access contact metadata.
- API connectivity issues: Verify network connectivity to Bitrix24 and that the API endpoint is reachable.
- Unexpected response format: If the API changes, the node might fail to parse field descriptions correctly. Updating the node or checking Bitrix24 API documentation may help.
- Missing fields: If some expected fields do not appear, confirm that the authenticated user has access rights to those fields in Bitrix24.
Links and References
- Bitrix24 REST API Documentation
- Bitrix24 CRM Contact Fields (for detailed field info)