Bitrix24 icon

Bitrix24

Работа с Bitrix24 API

Overview

This node integrates with the Bitrix24 CRM system to perform operations on various resources such as Leads, Deals, Contacts, and Companies. Specifically for the Lead - Get operation, it retrieves a single lead record by its ID from Bitrix24. Users can optionally specify which fields of the lead they want to retrieve.

Common scenarios where this node is beneficial include:

  • Fetching detailed information about a specific lead to use in workflows like sending personalized emails or updating other systems.
  • Retrieving selective data fields to optimize performance and reduce unnecessary data transfer.
  • Integrating Bitrix24 lead data into automation pipelines for reporting or further processing.

Example: You have a workflow that triggers when a new lead is created elsewhere, and you want to fetch additional details about that lead from Bitrix24 by its ID to enrich your data before continuing.

Properties

Name Meaning
ID The unique identifier of the lead record to retrieve. Required for get, update, delete.
Select Fields Optional list of lead fields to retrieve. If empty, all fields are returned.

The "Select Fields" property allows choosing from dynamically loaded lead fields available in Bitrix24, enabling users to specify exactly which data points they want.

Output

The node outputs an array of JSON objects representing the retrieved lead(s). For the Get operation, the output JSON contains the lead's data fields as key-value pairs according to the selected fields or all fields if none were specified.

Example output structure (simplified):

{
  "result": {
    "ID": "123",
    "NAME": "John Doe",
    "STATUS_ID": "NEW",
    "PHONE": [{"VALUE": "+1234567890", "VALUE_TYPE": "WORK"}],
    ...
  }
}

No binary data output is produced by this node.

Dependencies

  • Requires an active Bitrix24 API connection configured via an API authentication token or webhook URL credential.
  • The node uses the Bitrix24 webhook URL to send HTTP POST requests to endpoints like crm.lead.get.json.
  • Axios library is used internally for HTTP requests.

Troubleshooting

  • Missing Credentials: If no credentials or webhook URL are provided, the node will throw errors indicating these are required.
  • Invalid Lead ID: Providing an incorrect or non-existent lead ID will result in an error response from Bitrix24.
  • Field Selection Issues: Selecting invalid or unsupported fields may cause the API call to fail or return incomplete data.
  • API Errors: Network issues or Bitrix24 API downtime can cause request failures; ensure connectivity and valid credentials.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if some fail, returning error messages per item.

Links and References

Discussion