Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Overview

The node interacts with Bitrix24's Smart Process Automation (SPA) feature, specifically to retrieve a single SPA item by its ID. This operation is useful when you need to fetch detailed information about a specific SPA record within Bitrix24, such as a custom business process or entity managed via SPA.

Common scenarios include:

  • Retrieving the current state or data of a SPA item for further processing or decision-making in an automation workflow.
  • Fetching SPA item details to synchronize with other systems or databases.
  • Using SPA item data to trigger conditional logic or notifications based on its properties.

Example: You have a SPA type representing customer support tickets. Using this node, you can get the details of a particular ticket by its ID to check its status or assigned agent before taking further actions.

Properties

Name Meaning
Authentication Method to authenticate with Bitrix24:
- OAuth2 (recommended for production)
- Webhook (simpler but less secure)
- API Key
Type ID The identifier of the Smart Process type (SPA type) to specify which SPA entity to work with.
Item ID The unique identifier of the SPA item to retrieve.

Output

The node outputs JSON data representing the retrieved SPA item. The structure corresponds to the fields defined in the selected SPA type and includes all available properties of that item.

If the SPA item contains any binary data fields (not explicitly shown in the code), those would be included in the output's binary property, typically as file attachments or media related to the SPA item.

Dependencies

  • Requires access to a Bitrix24 account with appropriate permissions to read SPA items.
  • Needs one of the following authentication methods configured in n8n:
    • OAuth2 credentials for Bitrix24
    • A Bitrix24 webhook URL
    • An API key credential for Bitrix24
  • Uses Bitrix24 REST API endpoints to fetch SPA types and SPA item data.

Troubleshooting

  • Common issues:

    • Incorrect or missing SPA Type ID or Item ID will cause the node to fail to retrieve data.
    • Authentication failures due to invalid or expired tokens/keys.
    • Network or API rate limiting errors from Bitrix24.
  • Error messages:

    • Errors returned from Bitrix24 API calls will be propagated. For example, "Item not found" if the Item ID does not exist.
    • If the node is set to continue on failure, it returns an error object with message, resource name, and timestamp.
  • Resolutions:

    • Verify that the SPA Type ID and Item ID are correct and correspond to existing entities.
    • Ensure authentication credentials are valid and have sufficient permissions.
    • Check network connectivity and Bitrix24 service status.

Links and References

Discussion