Bitrix24 icon

Bitrix24

Work with Bitrix24 API

Actions25

Overview

This node interacts with the Bitrix24 CRM system to retrieve a Deal record. It supports two main ways to get a Deal: by specifying its unique ID or by applying filter criteria on Deal fields. This flexibility allows users to either fetch a specific known Deal or search for Deals matching certain conditions.

Common scenarios where this node is useful include:

  • Retrieving detailed information about a particular Deal when you know its ID.
  • Searching for Deals that meet specific criteria, such as Deals with a certain status, amount, or custom field value.
  • Selecting only certain fields of the Deal to reduce data volume and focus on relevant information.

For example, you could use this node to:

  • Get a Deal by its ID to update or analyze it further in your workflow.
  • Find the first Deal where the "Stage" field equals "Negotiation" and retrieve only the Deal name and amount.

Properties

Name Meaning
Get By Choose how to get the Deal:
- ID: Retrieve by Deal's unique identifier.
- Filter: Retrieve by applying one or more filter conditions on Deal fields.
ID The unique identifier of the Deal to retrieve. Required if "Get By" is set to "ID".
Filter Fields One or more filter conditions to apply when retrieving by filter. Each filter consists of:
- Field Name: The Deal field to filter by.
- Operation: Comparison operation (e.g., Equals, Not Equals, Greater Than, Contains, In List, etc.).
- Value: The value to compare the field against.
Select Fields Optional list of Deal fields to retrieve. If empty, a default set of fields will be returned.

Output

The node outputs an array of JSON objects representing Deal records. For the "Get" operation:

  • When getting by ID, the output contains a single Deal object with the requested fields.
  • When getting by filter, the output contains the first Deal matching the filter or an error object if none found.

Each Deal object includes the selected fields as key-value pairs. If no fields are explicitly selected, a default set of Deal fields is returned.

The node does not output binary data.

Example output JSON snippet (simplified):

[
  {
    "ID": "123",
    "TITLE": "Important Deal",
    "STAGE_ID": "WON",
    "OPPORTUNITY": "10000"
  }
]

If no Deal matches the filter, the output will be:

[
  {
    "error": "Запись не найдена"
  }
]

("Запись не найдена" means "Record not found" in Russian.)

Dependencies

  • Requires a valid Bitrix24 API webhook URL credential configured in n8n.
  • Uses Bitrix24 REST API endpoints under the webhook URL to perform operations.
  • No additional external dependencies beyond standard HTTP requests.

Troubleshooting

  • Missing Credentials or Webhook URL: The node throws errors if the Bitrix24 API credentials or webhook URL are missing. Ensure these are properly configured.
  • Invalid ID or No Matching Records: If the specified Deal ID does not exist or the filter returns no results, the node outputs an error object indicating "Record not found".
  • Filter Syntax: Filters must use supported operations; incorrect operations or malformed values may cause no results or errors.
  • API Errors: Network issues or invalid webhook URLs can cause request failures. Check connectivity and webhook validity.
  • Language Setting: The node sets a language environment variable based on credentials; if missing, defaults to Russian. This affects error messages and translations.

Links and References

Discussion