Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Actions89

Overview

The Bitrix24 node's "SPA" resource with the "Get Items" operation allows users to retrieve items from Bitrix24 Smart Process Automation (SPA) types. This is useful for automating workflows and integrating SPA data into other systems or processes within n8n.

Typical use cases include:

  • Fetching all or filtered SPA records for reporting or synchronization.
  • Retrieving specific fields of SPA items to reduce payload size.
  • Ordering SPA items by certain criteria such as creation date or ID.
  • Using different authentication methods (OAuth2, webhook, API key) depending on security needs.

For example, a user might want to get all SPA items of a particular type created after a certain date, ordered by their ID ascending, and only select specific fields like ID, Title, and Created By.

Properties

Name Meaning
Authentication Method used to authenticate API requests. Options: OAuth2 (recommended for production), Webhook (simpler but less secure), API Key.
Return All Boolean flag indicating whether to return all matching results or limit the number of returned items.
Type ID The identifier of the Smart Process type to query. This selects which SPA entity type the items belong to.
Options Additional options to customize the request:
- Access Token: Override the default token with a specific access token.
- Filter: JSON object specifying filter conditions using Bitrix24 filter syntax.
- Order: JSON object defining sorting order of results.
- Select: Comma-separated list of fields to return; leave empty to return all fields.

Output

The node outputs an array of JSON objects representing the SPA items retrieved from Bitrix24. Each item contains fields corresponding to the selected SPA type and the requested fields.

If binary data were involved (not indicated here), it would be summarized accordingly, but this operation deals with JSON data only.

Example output structure snippet:

[
  {
    "ID": "123",
    "TITLE": "Sample Item",
    "CREATED_BY": "45",
    "DATE_CREATE": "2023-01-15T12:34:56Z",
    ...
  },
  ...
]

Dependencies

  • Requires connection to a Bitrix24 instance.
  • Supports three authentication methods: OAuth2, webhook URL, or API key.
  • The node relies on Bitrix24 API endpoints for SPA types and items.
  • No additional external dependencies beyond standard Bitrix24 API credentials and network access.

Troubleshooting

  • Common issues:

    • Incorrect or expired authentication tokens leading to authorization errors.
    • Invalid filter or order JSON syntax causing API call failures.
    • Selecting a non-existent SPA type or fields resulting in empty or error responses.
    • Network connectivity problems preventing API calls.

  • Error messages:

    • Errors returned from Bitrix24 API will be surfaced in the node output if "Continue On Fail" is enabled.
    • Typical errors include authentication failures, invalid parameters, or rate limiting.

  • Resolutions:

    • Verify and refresh authentication credentials.
    • Validate JSON syntax for filter and order inputs.
    • Confirm SPA type IDs and field names exist in your Bitrix24 environment.
    • Check network connectivity and firewall settings.

Links and References

Discussion