Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The Bitrix24 node enables interaction with the Bitrix24 CRM and business platform. Specifically, the "Automation" resource with the "Create Rule" operation allows users to create automation rules within Bitrix24. These rules automate processes by triggering actions based on specified conditions in CRM entities or Smart Processes.

This node is beneficial for automating repetitive tasks such as updating deal statuses, sending notifications, or integrating external systems via webhooks. For example, a user can create an automation rule that triggers when a new deal is created, sending data to an external application for further processing.

Properties

Name Meaning
Authentication Method of authentication to use: OAuth2 (recommended), Webhook URL (simpler but less secure), or API Key.
Document Type The 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 specific Smart Process with automation enabled (only shown if Document Type is a Smart Process).
Code Unique internal identifier for the automation rule; must be unique within the application. Allowed characters include letters, numbers, dot, hyphen, and underscore.
Handler URL URL where the automation rule sends data via the Bitrix24 queue server. Must be on the same domain as the Bitrix24 application installation.
Name Human-readable name of the automation rule.
Localized Names Optionally enable and provide localized names for different languages.
Description Description text explaining the purpose of the automation rule.
Localized Descriptions Optionally enable and provide localized descriptions for different languages.
Auth User ID Identifier of the user whose token will be passed to the application when the rule triggers.
Sync Rule Whether the automation rule should wait synchronously 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 rule
- Current Status: Document status for status-based rules
- Trigger Order: Execution priority (lower runs 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 identifier
Custom Properties Additional custom properties for the automation rule, each with a name, type (string, number, boolean, array, object), and corresponding value field.
Use JSON for Properties Whether to set 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 operation. Each item contains a json property with the response data from Bitrix24 after creating the automation rule. If an error occurs and "Continue On Fail" is enabled, the output includes an error message, the resource name, and a timestamp.

No binary data output is indicated.

Dependencies

  • Requires connection to a Bitrix24 instance.
  • Supports three authentication methods: OAuth2, Webhook URL, or API Key. Appropriate credentials must be configured in n8n.
  • The node relies on Bitrix24 API endpoints to create automation rules and fetch dynamic options like document types and Smart Process types.
  • Network access to Bitrix24 API and the handler URL endpoint is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing authentication credentials will cause API call failures.
    • The handler URL must be accessible and on the same domain as the Bitrix24 application; otherwise, the rule creation may fail.
    • The "Code" property must be unique; duplicate codes will likely cause errors.
    • Incorrect JSON syntax in the "Properties JSON" field can cause parsing errors.
    • Selecting unsupported document types or Smart Processes without automation enabled may lead to empty or error responses.

  • Error Messages:

    • API errors returned from Bitrix24 will be included in the output if "Continue On Fail" is enabled.
    • Errors related to loading dynamic options (e.g., document types, SPA types) are logged internally and surfaced as option entries indicating failure.

  • Resolution Tips:

    • Verify authentication credentials and permissions.
    • Ensure the handler URL is correct and reachable.
    • Use unique codes for each automation rule.
    • Validate JSON input fields before execution.
    • Check Bitrix24 documentation for supported document types and Smart Processes.

Links and References

Discussion