Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Overview

The Bitrix24 node allows interaction with the Bitrix24 CRM and business platform. Specifically, the Data Storage - Get Item operation retrieves a single item from a specified entity type within Bitrix24. This is useful when you need to fetch detailed information about a particular record, such as a lead, deal, contact, or any other CRM entity.

Common scenarios include:

  • Retrieving customer details by their ID for further processing.
  • Fetching a specific deal or lead to update or analyze its data.
  • Integrating Bitrix24 data into workflows that require real-time access to individual records.

Example: You want to get the details of a CRM lead with ID "12345" to send a personalized email or update another system.

Properties

Name Meaning
Authentication Method to authenticate with Bitrix24: OAuth2 (recommended), Webhook URL (simpler but less secure), or API Key authentication.
Entity Type The type of entity to work with, e.g., CRM_LEAD, CRM_DEAL, CRM_CONTACT.
Item ID The unique identifier of the item to retrieve.
Options Additional optional parameters:
- Access Token Access token string for authentication override.
- Filter JSON object specifying filter criteria (not typically used in Get Item but available).
- Select Comma-separated list of fields to select from the item.
- Order JSON object defining order criteria (more relevant for list operations).
- Start Number indicating start position for pagination (not applicable for single item retrieval).

Output

The output contains the retrieved item's data in the json field of the output item. This will be an object representing all the fields and values of the requested entity item.

If the node supports binary data (not explicitly shown here), it would represent files or attachments related to the item, but this operation primarily returns structured JSON data.

Example output structure snippet:

{
  "ID": "12345",
  "NAME": "John Doe",
  "EMAIL": "john.doe@example.com",
  "PHONE": "+1234567890",
  ...
}

Dependencies

  • Requires valid authentication credentials configured in n8n:
    • OAuth2 credentials (recommended for production use).
    • Or a webhook URL.
    • Or an API key credential.
  • The node depends on Bitrix24's REST API endpoints to fetch entity data.
  • No additional external libraries beyond those bundled are required.

Troubleshooting

  • Common issues:

    • Invalid or expired authentication tokens leading to authorization errors.
    • Incorrect Entity Type or Item ID causing "item not found" errors.
    • Insufficient permissions in Bitrix24 for the authenticated user.
    • Network connectivity issues preventing API calls.
  • Error messages:

    • "error": "Invalid authentication": Check your credentials and refresh tokens if needed.
    • "error": "Item not found": Verify the Entity Type and Item ID are correct and exist.
    • "error": "Access denied": Ensure the authenticated user has permission to read the entity.
  • Resolution tips:

    • Double-check the authentication method and credentials.
    • Confirm the entity type matches Bitrix24's expected values (case-sensitive).
    • Validate the item ID exists in Bitrix24.
    • Use the Bitrix24 web interface or API explorer to verify access.

Links and References

Discussion