Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The Bitrix24 node allows interaction with the Bitrix24 CRM and business platform, specifically enabling management of Smart Process Automation (SPA) types. The "Update Type" operation for the SPA resource lets users modify existing Smart Process types by changing their properties and enabling or disabling various features related to the SPA type.

This node is beneficial in scenarios where businesses want to automate and customize their CRM workflows by updating SPA types programmatically. For example, a user might update an SPA type to enable automation rules, add custom sales funnels, or link it with catalog products without manually configuring these settings in the Bitrix24 UI.

Practical examples include:

  • Enabling document printing and automation triggers on a specific SPA type.
  • Updating the SPA type's name or description to reflect new business processes.
  • Activating the recycle bin feature or setting open permissions for new elements in the SPA.

Properties

Name Meaning
Authentication Method of authentication: OAuth2 (recommended), Webhook URL (simpler but less secure), or API Key.
Type Name (title) The name of the Smart Process type to update.
Type ID (id) Identifier of the Smart Process type to update; selected from available SPA types.
Enable Client Field Whether to enable the Client field with bindings to Contacts and Companies.
Enable Document Printing Whether to enable document printing functionality for the SPA type.
Enable Use in User Field Whether to allow the SPA type to be used in user fields.
Enable Product Binding Whether to enable binding of catalog products to the SPA type.
Enable Company Details Field Whether to enable the "Your Company Details" field.
Enable Observers Field Whether to enable the Observers field.
Enable Recycle Bin Whether to enable recycle bin functionality for deleted SPA items.
Enable Automation Rules & Triggers Whether to enable automation rules and triggers for the SPA type.
Enable Start Date & End Date Fields Whether to enable Start Date and End Date fields for SPA items.
Enable Business Process Designer Whether to enable the use of the business process designer with this SPA type.
Enable Custom Sales Funnels Whether to enable custom sales funnels and tunnels for the SPA type.
Enable Source Field Whether to enable the Source field.
Enable Set Open Permissions for New Elements Whether to enable setting open permissions for new SPA elements.
Enable Payment Stage Field Whether to enable the Payment Stage field.
Enable REST API Whether to enable external access via REST API for this SPA type (default enabled).
Options A collection of additional optional settings:
- Entity Type ID: Numeric identifier of the SPA (≥1030 or in range 128-192).
- Entity Type Code: Code identifier (lowercase, no spaces).
- Description: Text description of the SPA type.
- Relations: JSON object defining links to other CRM entities.
- Linked User Fields: JSON object specifying user fields where this SPA should appear when enabled.

Output

The node outputs an array containing one item with a json property representing the result of the update operation. This typically includes confirmation data returned by the Bitrix24 API about the updated SPA type.

If an error occurs and "Continue On Fail" is enabled, the output will contain an error object with:

  • error: The error message string.
  • resource: The resource name ("spa").
  • timestamp: ISO timestamp of the error occurrence.

No binary data output is indicated for this operation.

Dependencies

  • Requires connection to a Bitrix24 instance with appropriate permissions.
  • Supports three authentication methods: OAuth2, Webhook URL, or API Key credential.
  • Uses Bitrix24 REST API endpoints internally to perform SPA type updates.
  • No additional external dependencies beyond Bitrix24 API access.

Troubleshooting

  • Common Issues:

    • Invalid or missing SPA Type ID: Ensure the selected SPA type exists and the ID is correct.
    • Insufficient permissions: The API credentials must have rights to update SPA types.
    • Malformed JSON in relations or linkedUserFields: These fields require valid JSON format.
    • Network or authentication errors: Verify API keys, OAuth tokens, or webhook URLs are valid and active.

  • Error Messages:

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

  • Resolution Tips:

    • Double-check all required fields are provided and correctly formatted.
    • Validate JSON inputs using external tools before inputting.
    • Refresh or reauthorize credentials if authentication errors occur.
    • Consult Bitrix24 API documentation for specific error codes and meanings.

Links and References

Discussion