Bitrix24

Interact with Bitrix24 CRM and business platform

Actions89

Overview

The Bitrix24 node enables interaction with the Bitrix24 CRM and business platform, specifically allowing users to create automation rules within Bitrix24. The "Create Rule" operation under the "Automation" resource lets users define new automation rules that trigger actions based on specified conditions in Bitrix24 entities such as CRM deals, leads, contacts, or Smart Processes.

This node is beneficial for automating workflows inside Bitrix24, such as triggering external webhooks when a deal reaches a certain status, synchronizing data with other systems, or customizing business logic without manual intervention.

Practical examples:

Automatically notify an external system via webhook when a CRM deal status changes.
Create custom automation rules for Smart Processes to handle specific business scenarios.
Synchronize Bitrix24 automation events with third-party applications using API keys or OAuth2 authentication.

Properties

Name	Meaning
Authentication	Method of authenticating with Bitrix24: OAuth2 (recommended), Webhook URL (simpler but less secure), or API Key.
Document Type	Type of document/entity the automation rule applies to, e.g., CRM Deal, Lead, Contact, Company, Quote, Invoice, or Smart Process Automation entities.
Smart Process	Select a Smart Process with automation enabled (only shown if Document Type is Smart Process).
Code	Unique internal identifier for the automation rule; allowed characters include letters, numbers, dot, hyphen, and underscore.
Handler URL	URL where the automation rule sends data via Bitrix24 queue server; must be on the same domain as the Bitrix24 application installation.
Name	Human-readable name of the automation rule.
Localized Names	Option to provide localized names for different languages by specifying language codes and corresponding names.
Description	Description text explaining the purpose or details of the automation rule.
Localized Descriptions	Option to provide localized descriptions for different languages by specifying language codes and corresponding descriptions.
Auth User ID	Identifier of the user whose token will be passed to the application when the automation rule triggers.
Sync Rule	Boolean indicating whether the automation rule should wait for a response from the external application before continuing.
Common Properties	Collection of common settings including: • Placement: Where the rule appears in the UI (Trigger List, Details Card, Activity Panel) • Status IDs: Statuses that trigger the automation • Current Status: Document status for status-based rules • Trigger Order: Execution priority (lower first) • Icon Type: Standard or Custom icon • Icon File URL: URL for custom icon • Icon: Predefined icon choice • Sync: Whether to sync with external systems • Template ID: Associated template ID
Custom Properties	Additional custom properties defined as name-value pairs with types (string, number, boolean, array, object). Values are provided accordingly.
Use JSON for Properties	If true, sets additional properties as a single JSON object instead of individual fields.
Properties JSON	JSON object containing additional properties for the automation rule (used if "Use JSON for Properties" is true).

Output

The node outputs an array of items representing the result of the automation rule creation process. Each item contains a json field with the response data from Bitrix24, which typically includes details about the created automation rule such as its ID, code, name, and other metadata.

If an error occurs and the node is configured to continue on failure, the output will contain an item with an error message, the resource name, and a timestamp.

The node does not output binary data.

Dependencies

Requires connection to Bitrix24 via one of the supported authentication methods:
- OAuth2 authentication (recommended for production use).
- Bitrix24 webhook URL.
- Bitrix24 API key.
The node depends on Bitrix24 API endpoints to fetch dynamic options and to create automation rules.
Proper configuration of credentials in n8n is necessary to authenticate API calls.
The handler URL property requires a valid URL accessible by Bitrix24's queue server, typically on the same domain as the Bitrix24 application.

Troubleshooting

Common issues:
- Invalid or missing authentication credentials can cause authorization failures.
- Incorrect or unreachable handler URLs will prevent the automation rule from sending data correctly.
- Duplicate or invalid code values may cause errors since the code must be unique.
- Using unsupported characters in the code property can lead to validation errors.
- Misconfigured status IDs or document types might result in rules that never trigger.
Error messages:
- Errors returned from Bitrix24 API calls will be surfaced in the node output if "Continue On Fail" is enabled.
- Messages related to failed authentication indicate checking API keys, OAuth tokens, or webhook URLs.
- Validation errors about required fields or unique constraints suggest reviewing input parameters.
Resolution tips:
- Verify all required fields are filled correctly.
- Ensure the handler URL is publicly accessible and matches the domain requirements.
- Confirm the uniqueness of the code property within the Bitrix24 application.
- Check that the selected document type and statuses exist and are valid in your Bitrix24 instance.
- Review API credentials and refresh tokens if needed.