Bitrix icon

Bitrix

Consume Bitrix24 REST API

Overview

This node integrates with the Bitrix24 REST API to create new CRM items of a specified entity type. It is designed for users who want to automate the creation of various CRM records such as leads, deals, contacts, or custom entities within Bitrix24. The node supports two authentication methods: OAuth2 and Webhook.

Typical use cases include:

  • Automatically creating CRM records from form submissions or other data sources.
  • Integrating Bitrix24 CRM with external systems by programmatically adding new items.
  • Bulk creation of CRM entries using JSON input for complex data structures.

Properties

Name Meaning
Authentication Method used to authenticate with Bitrix24 API. Options: OAuth2 (standard OAuth2 flow) or Webhook (using a webhook URL).
Entity Type Name or ID Identifier of the CRM entity type to create (e.g., Lead, Deal, Contact, or custom entity). Choose from a dynamically loaded list or specify an ID via expression.
Input Type How to provide the data for the new item. Options: Using Fields (fill individual fields) or Using JSON (provide raw JSON data representing the entire item).
Fields When "Using Fields" is selected, this collection allows specifying multiple field name-value pairs to set on the new item. Field names are dynamically loaded based on the selected entity type.
JSON Body When "Using JSON" is selected, provide the complete item data as raw JSON.
Use Original UF Names Boolean flag indicating whether to use original custom field names prefixed with UF_CRM instead of simplified names. Applies only to custom fields in CRM items.

Output

The node outputs the created CRM item(s) in the json output field. This typically includes the newly created item's unique identifier and any other relevant metadata returned by the Bitrix24 API after creation.

If binary data were involved (not applicable here), it would be summarized accordingly, but this node focuses on JSON data representing CRM items.

Dependencies

  • Requires access to Bitrix24 REST API.
  • Requires either OAuth2 credentials or a valid webhook URL configured in n8n for authentication.
  • Dynamic loading of entity types and fields depends on Bitrix24 API availability.
  • No additional external dependencies beyond standard HTTP requests to Bitrix24.

Troubleshooting

  • Authentication errors: Ensure that the OAuth2 credentials or webhook URL are correctly configured and have sufficient permissions to create CRM items.
  • Invalid Entity Type: If the entity type ID or name is incorrect or not accessible, the node will fail. Verify the entity type exists in your Bitrix24 instance.
  • Field validation errors: When using individual fields, ensure that field names and values conform to Bitrix24 requirements. Using raw JSON can help bypass some UI limitations but requires correct JSON structure.
  • API rate limits or connectivity issues: Bitrix24 may throttle requests; handle retries or check network connectivity if errors occur.
  • Use Original UF Names flag: If custom fields are not recognized, toggling this option may resolve naming mismatches.

Links and References

Discussion