Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Actions290

Overview

This node integrates with the Bitrix24 CRM and business platform, allowing users to interact programmatically with various CRM resources. Specifically, the "CRM" resource with the "Get Fields" operation enables retrieving metadata about fields available for different CRM entities such as contacts, deals, leads, companies, quotes, invoices, products, and activities.

Typical use cases include:

  • Dynamically fetching field definitions to build forms or UI elements.
  • Validating data against the CRM schema before creating or updating records.
  • Automating workflows that depend on CRM field metadata.

For example, a user might want to get all available fields for a "Contact" entity to map incoming data from another system correctly.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24:
- OAuth2 (recommended for production)
- Webhook (simpler but less secure)
- API Key
Entity The CRM entity type to work with. Options include:
- Contact
- Deal
- Lead
- Company
- Quote
- Invoice
- Product
- Activity

Output

The node outputs an array of objects representing the fields of the selected CRM entity. Each object typically contains:

  • name: The display label of the field (e.g., "First Name", "Status").
  • value: The internal field ID used by Bitrix24 (e.g., "NAME", "STATUS_ID").
  • description: Additional information about the field, such as its type and whether it is required.

If an error occurs during the retrieval, the output will contain an object with an error message describing the failure.

The output is structured in the json property of each item. This node does not output binary data.

Dependencies

  • Requires authentication credentials for Bitrix24, which can be provided via OAuth2, webhook URL, or API key.
  • Uses Bitrix24's REST API endpoints to fetch CRM field metadata.
  • No additional external dependencies beyond standard HTTP requests to Bitrix24.

Troubleshooting

  • Common Issues:

    • Incorrect or expired authentication credentials may cause authorization failures.
    • Network connectivity issues can prevent API calls from succeeding.
    • Selecting an unsupported or misspelled entity type will result in no fields being returned.
  • Error Messages:

    • "Failed to load CRM fields: <error message>" indicates an issue calling the Bitrix24 API or parsing its response.
    • If the node returns an empty list or a single entry indicating an error, verify the entity type parameter and authentication method.
  • Resolutions:

    • Ensure valid and active credentials are configured in n8n.
    • Confirm the entity type is one of the supported options.
    • Check network access to Bitrix24 API endpoints.
    • Enable "Continue On Fail" if you want the workflow to proceed despite errors and handle them downstream.

Links and References

Discussion