Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Actions290

Overview

The "Download Document" operation of the Bitrix24 node's Document Generator resource allows users to download a generated document by specifying its unique Document ID. This operation is useful in workflows where documents are dynamically created within Bitrix24 (such as contracts, invoices, or reports) and need to be retrieved for further processing, storage, or distribution.

Typical use cases include:

  • Automatically downloading a contract after it has been generated to send via email.
  • Retrieving an invoice document to archive it in an external system.
  • Fetching reports generated in Bitrix24 for analysis or backup.

This operation supports multiple authentication methods, including OAuth2, webhook URL, and API key, providing flexibility depending on security requirements and environment setup.

Properties

Name Meaning
Authentication Method used to authenticate with Bitrix24. Options: OAuth2 (recommended), Webhook, API Key.
Document ID The unique identifier of the generated document to download.
Options Additional optional parameters. Currently supports: Access Token (string) for authentication.

Output

The output of this operation is the downloaded document data associated with the specified Document ID. The data is provided in the json output field, typically containing metadata about the document and possibly the document content or a link to it.

If the document includes binary data (e.g., PDF or DOCX file), the node will handle it accordingly, allowing subsequent nodes to process or save the binary file.

Dependencies

  • Requires valid authentication credentials for Bitrix24, which can be configured using OAuth2, webhook URL, or API key.
  • The node depends on Bitrix24's API endpoints for document generation and retrieval.
  • Proper permissions in Bitrix24 are necessary to access and download documents.

Troubleshooting

  • Invalid Document ID: If the provided Document ID does not exist or is incorrect, the node may throw an error indicating the document could not be found. Verify the Document ID is correct.
  • Authentication Errors: Using incorrect or expired credentials will result in authentication failures. Ensure that the selected authentication method is properly configured and tokens are valid.
  • Access Denied: Insufficient permissions in Bitrix24 for the authenticated user can cause access errors. Confirm that the user or API key has rights to access document resources.
  • Network Issues: Connectivity problems between n8n and Bitrix24 API endpoints can cause timeouts or failures. Check network connectivity and proxy settings if applicable.
  • Continue On Fail: If enabled, the node will return an error object in the output JSON instead of failing the workflow, allowing graceful error handling.

Links and References

Discussion