Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The Bitrix24 node allows interaction with the Bitrix24 CRM and business platform. Specifically, for the Automation resource and the Get Rule operation, it retrieves details of a specific automation rule by its ID. This is useful when you want to fetch configuration or status information about an existing automation rule within Bitrix24, such as rules that trigger actions based on CRM events.

Common scenarios include:

  • Fetching an automation rule's details to display or audit its settings.
  • Integrating Bitrix24 automation rules into workflows where decisions depend on rule configurations.
  • Synchronizing automation rules data with other systems.

Example: You have an automation rule in Bitrix24 that triggers when a deal reaches a certain stage. Using this node, you can retrieve that rule’s details to check its conditions or actions programmatically.

Properties

Name Meaning
Authentication Method used to authenticate with Bitrix24. Options:
• OAuth2 (recommended for production)
• Webhook (simpler but less secure)
• API Key authentication
Code The unique identifier (ID) of the automation rule to retrieve. This is required to specify which rule to get.
Document Type The type of document/entity the automation rule applies to. Options are dynamically loaded and include CRM entities like Deal, Lead, Contact, Company, Quote, Invoice, and Smart Process Automation entities.
Smart Process When the Document Type is set to a Smart Process Automation entity, this property lets you select the specific Smart Process with automation enabled. It is required in that context.

Output

The node outputs JSON data representing the retrieved automation rule. The structure includes all relevant fields returned by the Bitrix24 API for the rule identified by the provided ID. This typically contains metadata about the rule, its conditions, actions, and related configuration.

If the node encounters an error (e.g., invalid rule ID), it returns a JSON object with an error field describing the issue, along with 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 depends on Bitrix24 API endpoints to fetch automation rule data.
  • Proper credentials must be configured in n8n for the chosen authentication method.
  • Network access to Bitrix24 API endpoints is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing rule ID (Code property) will cause errors.
    • Authentication failures due to incorrect or expired credentials.
    • Insufficient permissions in Bitrix24 account to read automation rules.
    • Network connectivity problems preventing API calls.

  • Error messages:

    • Errors from Bitrix24 API are surfaced in the output under the error field.
    • If the node is set to continue on fail, errors return as JSON objects with error details; otherwise, execution stops with an exception.

  • Resolutions:

    • Verify the rule ID exists and is correct.
    • Check and refresh authentication credentials.
    • Ensure the Bitrix24 user has rights to access automation rules.
    • Confirm network connectivity and API endpoint accessibility.

Links and References

Discussion