Bitrix24Install

Overview

This node integrates with the Bitrix24 CRM and business platform, enabling users to interact programmatically with various Bitrix24 resources. Specifically, for the Document Generator resource with the Get Template Fields operation, it retrieves the fields available in a document template within Bitrix24.

Common scenarios where this node is beneficial include:

• Automating document creation workflows by dynamically fetching template fields.
• Integrating Bitrix24 document templates into broader automation pipelines.
• Validating or mapping data fields before generating documents.

For example, a user might use this node to fetch all fields from a specific document template to populate those fields automatically with CRM data before generating a contract or invoice.

Properties

Note: The provided properties JSON only includes the "Authentication" property. Other properties related to selecting the Document Generator resource or specifying the template are defined elsewhere in the node but are not included here.

Output

The node outputs an array of items, each containing a json object representing the retrieved data from Bitrix24.

For the Get Template Fields operation, the output's json field contains the list of fields available in the selected document template. Each field typically includes:

• Field name or label
• Field ID or key
• Description including type and whether the field is required

If an error occurs during the retrieval, the output will contain an error object with:

• error: The error message string
• resource: The resource name ("Document Generator")
• timestamp: ISO timestamp of when the error occurred

The node does not output binary data.

Dependencies

• Requires connection to Bitrix24 via one of the supported authentication methods:

  • OAuth2 authentication (recommended)
  • Webhook URL authentication
  • API Key authentication

• The node depends on Bitrix24 API endpoints to fetch template fields and other resource data.

• Requires proper configuration of credentials in n8n corresponding to the chosen authentication method.

Troubleshooting

Common Issues

• Authentication failures: Incorrect or expired credentials can cause API calls to fail.
• API rate limits: Bitrix24 may limit the number of API requests; excessive calls could result in errors.
• Missing or incorrect resource/operation parameters: If the resource or operation is not properly set, the node cannot process the request.
• Network connectivity issues: Problems connecting to Bitrix24 API endpoints will cause failures.

Error Messages

• Errors returned from Bitrix24 API calls are caught and returned as part of the output if "Continue On Fail" is enabled.
• Typical error messages include failure to load fields or invalid authentication.
• To resolve errors:
  • Verify credentials and re-authenticate if necessary.
  • Check that the selected resource and operation parameters are correct.
  • Ensure network connectivity to Bitrix24 services.
  • Review Bitrix24 API documentation for any changes or limitations.

Links and References

• Bitrix24 Official API Documentation
• Bitrix24 Developer Portal
• n8n Documentation on Credentials
• OAuth2 Authentication Guide