Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

This node integrates with the Bitrix24 platform, specifically enabling management of Smart Process Automation (SPA) types within Bitrix24 CRM. The "Add Type" operation under the SPA resource allows users to create new SPA types with customizable features and settings.

Typical use cases include automating business workflows by defining custom SPA types tailored to specific organizational needs, such as tracking unique business processes or entities not covered by default CRM objects. For example, a company might create a SPA type for managing internal project requests or equipment maintenance logs, enabling automation, custom fields, and integration with other CRM entities.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24: OAuth2 (recommended), Webhook URL (simpler but less secure), or API Key authentication.
Type Name The name of the Smart Process type to be created.
Enable Client Field Whether to enable a Client field that binds to Contacts and Companies.
Enable Document Printing Whether to enable document printing capabilities for this SPA type.
Enable Use in User Field Whether to allow this SPA type to be used in user-defined fields.
Enable Product Binding Whether to enable binding catalog products to this SPA type.
Enable Company Details Field Whether to enable the "Your Company Details" field.
Enable Observers Field Whether to enable an Observers field to track observers of SPA items.
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 this 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 for this SPA type.
Enable Custom Sales Funnels Whether to enable custom sales funnels and tunnels for this SPA type.
Enable Source Field Whether to enable a Source field to track origin information.
Enable Set Open Permissions for New Elements Whether to set open permissions for newly created SPA elements.
Enable Payment Stage Field Whether to enable a Payment Stage field.
Enable REST API Whether to enable external access to this SPA type via REST API (enabled by default).
Options A collection of additional optional settings:
- Entity Type ID Numeric identifier for the SPA type; must be ≥ 1030 or between 128-192.
- Entity Type Code Code identifier for the entity type; lowercase, no spaces.
- Description Text description of the SPA type.
- Relations JSON object defining links to other CRM entities, e.g., parent or child relationships.
- Linked User Fields JSON object specifying user fields where this SPA should appear if enabled in user fields.

Output

The node outputs an array containing one item with a json property representing the result of the SPA type creation request. This typically includes confirmation details from Bitrix24 about the newly created SPA type or error information if the operation failed.

If the node encounters an error and is configured to continue on failure, it outputs an object with an error message, the resource name, and a timestamp.

No binary data output is involved in this operation.

Dependencies

  • Requires connection to Bitrix24 CRM via one of the supported authentication methods: OAuth2, webhook URL, or API key.
  • Uses Bitrix24 REST API endpoints to manage SPA types.
  • No additional external services are required beyond Bitrix24.
  • Proper credentials and permissions in Bitrix24 are necessary to create SPA types.
  • The node relies on internal helper functions to make authenticated API calls to Bitrix24.

Troubleshooting

  • Common Issues:

    • Invalid or insufficient permissions in Bitrix24 may cause API call failures.
    • Providing an invalid or duplicate Entity Type ID can lead to errors.
    • Incorrect JSON format in Relations or Linked User Fields properties may cause parsing errors.
    • Network connectivity issues or expired authentication tokens can prevent successful API calls.

  • Error Messages:

    • Errors returned from Bitrix24 API will be included in the output if "Continue On Fail" is enabled.
    • Typical messages include authorization failures, validation errors for input parameters, or server errors.

  • Resolutions:

    • Verify that the API credentials have appropriate scopes and permissions.
    • Ensure all required fields are correctly filled and JSON inputs are valid.
    • Refresh or reauthenticate OAuth2 tokens if expired.
    • Check network connectivity and Bitrix24 service status.

Links and References

Discussion