Actions89
- Direct API Actions
- CRM Actions
- Task Actions
- User Actions
- SPA Actions
- Activity Actions
- Automation Actions
- Document Generator Actions
- Data Storage Actions
- Chat Actions
Overview
The Bitrix24 node allows interaction with the Bitrix24 CRM and business platform. Specifically, for the Automation - Get Rule operation, it retrieves details of a specific automation rule by its ID within Bitrix24. This is useful when you want to fetch configuration or status information about an existing automation rule applied to CRM entities or Smart Processes.
Common scenarios include:
- Fetching automation rule details to display or audit automation workflows.
- Integrating Bitrix24 automation rules into external dashboards or reporting tools.
- Using retrieved rule data as input for further processing or conditional logic in n8n workflows.
Example: You have an automation rule that triggers notifications on deal stage changes. Using this node, you can retrieve the rule's configuration to verify its conditions or actions programmatically.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method to authenticate with Bitrix24 API: - OAuth2 (recommended for production) - Webhook (simpler but less secure) - API Key authentication |
| Code | The unique ID of the automation rule to retrieve. This is required to specify which rule's details to fetch. |
| Document Type | The type of document/entity the automation rule applies to. Options are dynamically loaded and include CRM entities like deals, leads, contacts, companies, quotes, invoices, products, activities, and Smart Process Automation. Defaults to "crm_deal". |
| Smart Process | When the Document Type is set to Smart Process (spa_placement), this property lets you select the specific Smart Process with automation enabled. It loads available Smart Processes dynamically. This is required if using Smart Process as Document Type. |
Output
The node outputs an array of items where each item contains a json object representing the retrieved automation rule's details from Bitrix24. The exact structure depends on Bitrix24's API response for the automation rule but typically includes fields such as rule ID, name, conditions, actions, and metadata.
If an error occurs and "Continue On Fail" is enabled, the output will contain an item with an error field describing the issue, along with the resource name and a timestamp.
This node does not output binary data.
Dependencies
- Requires access to a Bitrix24 account with appropriate permissions to read automation rules.
- Requires one of the following authentication methods configured in n8n:
- OAuth2 credentials for Bitrix24
- A Bitrix24 webhook URL
- An API key credential for Bitrix24
- The node uses internal helper functions to make API calls to Bitrix24 endpoints.
Troubleshooting
Common issues:
- Invalid or missing automation rule ID (
Codeproperty) will cause the API call to fail. - Insufficient permissions or incorrect authentication setup may result in authorization errors.
- If the specified Document Type or Smart Process is incorrect or not enabled for automation, the rule might not be found.
- Invalid or missing automation rule ID (
Error messages:
- Errors returned from Bitrix24 API will be propagated unless "Continue On Fail" is enabled.
- Typical error messages include "Rule not found", "Unauthorized", or network-related errors.
Resolutions:
- Verify the automation rule ID is correct and exists in Bitrix24.
- Ensure the authentication credentials are valid and have necessary scopes/permissions.
- Confirm the Document Type and Smart Process selections match the rule's context.
- Enable "Continue On Fail" to handle errors gracefully in workflows.