Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The Bitrix24 node allows users to interact with the Bitrix24 CRM and business platform, specifically enabling automation rule management among other resources. The "Update Rule" operation under the "Automation" resource lets users modify existing automation rules within Bitrix24. This is useful for dynamically adjusting business process automations such as triggers, handlers, and conditions without manual intervention in the Bitrix24 interface.

Common scenarios include:

  • Updating an automation rule's handler URL to point to a new webhook endpoint.
  • Changing the name or description of an automation rule to reflect updated business logic.
  • Modifying the trigger conditions or status IDs that activate the automation.
  • Adding localized names and descriptions for multi-language support.
  • Adjusting synchronization settings to control whether the rule waits for external responses.

Practical example: A sales team updates an automation rule to change the webhook URL that processes deal stage changes, ensuring integration with a new internal system.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24: OAuth2 (recommended), Webhook URL (simpler but less secure), or API Key.
Code (ruleId) The unique identifier (ID) of the automation rule to update.
Document Type The type of document the automation rule applies to, e.g., CRM Deal, Lead, Contact, Company, Quote, Invoice, or Smart Process Automation entities.
Smart Process Selects a specific Smart Process with automation enabled (required if Document Type is a Smart Process).
Code Internal unique code for the automation rule within the application; must be unique and follow allowed characters (a-z, A-Z, 0-9, dot, hyphen, underscore).
Handler URL The URL where the automation rule sends data via the Bitrix24 queue server; must be on the same domain as the application installation.
Name The display name of the automation rule.
Localized Names Boolean flag indicating whether to use localized names for different languages.
Localized Names (list) Collection of localized names, each with a language code (e.g., en, de, fr, ru) and corresponding name string.
Description Text description of the automation rule.
Localized Descriptions Boolean flag indicating whether to use localized descriptions for different languages.
Localized Descriptions (list) Collection of localized descriptions, each with a language code and corresponding description text.
Auth User ID Numeric ID of the user whose token will be passed to the application when the rule executes.
Sync Rule Boolean indicating if the automation rule should wait synchronously for a response from the application before continuing.
Common Properties Collection of common properties including:
- Placement: Where the rule appears in the UI (Trigger List, Details Card, Activity Panel)
- Status IDs: Statuses triggering 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 identifier
Custom Properties Multiple custom properties can be added, each with:
- Property Name
- Property Type (String, Number, Boolean, Array, Object)
- Corresponding value field depending on type (stringValue, numberValue, booleanValue, complexValue as JSON)
Use JSON for Properties Boolean flag to specify if additional properties are provided as a single JSON object instead of individual fields.
Properties JSON JSON object containing additional properties for the automation rule when Use JSON for Properties is true.

Output

The node outputs an array of items, each containing a json object representing the result of the update operation. The exact structure depends on the Bitrix24 API response but typically includes confirmation of the updated rule details or error information.

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

No binary data output is indicated for this operation.

Dependencies

  • Requires connection to Bitrix24 via one of the supported authentication methods: OAuth2, Webhook URL, or API Key.
  • The node relies on Bitrix24 API endpoints to perform operations, so valid credentials and network access to Bitrix24 services are necessary.
  • No additional external dependencies beyond standard n8n environment and Bitrix24 API access.

Troubleshooting

  • Authentication errors: Ensure the selected authentication method is correctly configured with valid credentials or tokens.
  • Invalid rule ID: The ruleId must correspond to an existing automation rule; otherwise, the API will return an error.
  • Handler URL domain mismatch: The handler URL must be on the same domain as the Bitrix24 application installation; otherwise, the update may fail.
  • Invalid property formats: When using JSON for properties, ensure the JSON is well-formed and matches expected schema.
  • Permission issues: The authenticated user must have sufficient permissions to update automation rules.
  • API rate limits or connectivity issues: Network problems or Bitrix24 API limits may cause failures; retry or check API status.

Common error messages will include descriptive text from Bitrix24 API responses, which should guide corrective actions.

Links and References

Discussion