Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The "Get Template" operation of the Document Generator resource in this Bitrix24 node allows users to retrieve a specific document template by its ID from the Bitrix24 platform. This is useful when you want to fetch the details or content of an existing document template for further processing, such as previewing, editing, or generating documents based on that template.

Common scenarios include:

  • Automating document workflows where templates are dynamically selected and fetched.
  • Integrating Bitrix24 document templates into other systems or processes.
  • Validating or displaying template information before generating documents.

For example, you might use this node to get a contract template stored in Bitrix24, then fill it with client data in subsequent steps.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24: OAuth2 (recommended), Webhook (simpler), or API Key
Template ID The unique identifier of the document template to retrieve
Options Additional optional parameters; currently supports specifying an Access Token manually

Output

The node outputs JSON data representing the retrieved document template. The structure typically includes all relevant template details as returned by the Bitrix24 API, such as template metadata, fields, and content definitions.

If the node supports binary data output (not explicitly shown here), it would represent the actual document file or related binary content. However, for the "Get Template" operation, the primary output is JSON describing the template.

Dependencies

  • Requires authentication with Bitrix24 via one of the supported methods: OAuth2, Webhook URL, or API Key.
  • Needs proper configuration of credentials in n8n corresponding to the chosen authentication method.
  • Relies on Bitrix24's API endpoints for document template management.

Troubleshooting

  • Common issues:

    • Invalid or missing Template ID will cause the API call to fail.
    • Authentication errors if credentials are incorrect or expired.
    • Network or permission issues preventing access to the Bitrix24 API.

  • Error messages:

    • Errors returned from Bitrix24 API will be surfaced, often indicating invalid template ID or authentication failure.
    • If continueOnFail is enabled, errors are returned as part of the output JSON with error message and timestamp.

  • Resolutions:

    • Verify the Template ID is correct and exists in Bitrix24.
    • Ensure credentials are valid and have necessary permissions.
    • Check network connectivity and API endpoint accessibility.

Links and References

Discussion