Bitrix icon

Bitrix

Consume Bitrix24 REST API

Overview

This node integrates with the Bitrix24 CRM system to list deals based on specified criteria. It allows users to retrieve a filtered, sorted, and paginated list of deals from their Bitrix24 account. This is useful for automating workflows that require deal data extraction, such as reporting, syncing with other systems, or triggering actions based on deal attributes.

Practical examples:

  • Fetch all deals created in the last month to generate sales reports.
  • Retrieve deals with a specific status or stage to trigger follow-up tasks.
  • List deals ordered by amount to prioritize high-value opportunities.

Properties

Name Meaning
Authentication Choose the authentication method to connect to Bitrix24: either OAuth2 or Webhook.
Input Type Select how to provide input parameters: "Using Fields" to fill individual fields or "Using JSON" to provide raw JSON data.
JSON Body (Shown if Input Type is "Using JSON") Provide the complete request data in JSON format for advanced use cases.
Parameters (Shown if Input Type is "Using Fields") Collection of parameters to customize the listing:
- Select Names or IDs Specify which fields to include in the response. You can choose from a list or specify field IDs using expressions.
- Filter Conditions Add one or more filters to narrow down the deals returned. Each filter includes: Field (selectable), Operation (e.g., equals, contains, greater than), and Value to compare.
- Order Define sorting order by specifying one or more fields and direction (ASC or DESC).
- Start Number indicating the offset from which to start returning results (for pagination).

Output

The node outputs an array of deal objects in the json field. Each object represents a deal with the fields requested via the "Select Names or IDs" property or included by default. The structure corresponds to Bitrix24's deal entity schema.

No binary data output is produced by this node.

Dependencies

  • Requires connection to Bitrix24 CRM via either OAuth2 authentication or Webhook authentication.
  • Users must configure appropriate credentials in n8n for the chosen authentication method.
  • Network access to Bitrix24 REST API endpoints is necessary.

Troubleshooting

  • Authentication errors: Ensure that the selected authentication method is correctly configured with valid credentials. OAuth2 tokens may expire and need refreshing.
  • Invalid filter or field names: Using incorrect or unsupported field names in filters or selection may cause API errors. Use the provided load options to select valid fields.
  • Empty results: If no deals are returned, verify filter conditions and pagination settings. Also confirm that the Bitrix24 account contains deals matching the criteria.
  • API rate limits: Bitrix24 may impose rate limits; excessive requests could lead to temporary blocking. Implement retries or reduce request frequency if needed.

Links and References

Discussion