Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Overview

The "Get Templates" operation of the Document Generator resource in this Bitrix24 node allows users to retrieve document templates filtered by entity type and active status. This is useful when automating document creation workflows within Bitrix24 CRM, such as generating contracts, invoices, or proposals based on specific CRM entities like Leads, Deals, Contacts, Companies, or Invoices.

Practical examples include:

  • Fetching all active invoice templates to generate billing documents.
  • Retrieving deal-related templates to automate proposal generation for sales opportunities.
  • Filtering templates by entity type to ensure only relevant templates are used in a workflow.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24: OAuth2 (recommended), Webhook (simpler), or API Key.
Filter Collection of filters to narrow down templates:
  Entity Type Select which CRM entity type to filter templates by: All, Lead, Deal, Contact, Company, Invoice.
  Active Boolean flag to filter templates by their active status (true = active templates only).
  Access Token Access token string used for authentication (optional depending on auth method).

Output

The node outputs an array of JSON objects representing the document templates that match the specified filters. Each item in the output contains details about a template, such as its ID, name, and other metadata provided by the Bitrix24 API.

If an error occurs during execution and "Continue On Fail" is enabled, the output will contain an object with an error field describing the issue, along with the resource name and a timestamp.

No binary data output is indicated for this operation.

Dependencies

  • Requires connection to a Bitrix24 instance via one of the supported authentication methods:
    • OAuth2 authentication (recommended for production use).
    • Webhook URL authentication (simpler but less secure).
    • API key authentication.
  • The node depends on Bitrix24's API endpoints to fetch document templates.
  • Proper credentials must be configured in n8n for the chosen authentication method.

Troubleshooting

  • Common Issues:

    • Incorrect or expired authentication credentials can cause authorization failures.
    • Network connectivity issues may prevent API calls from succeeding.
    • Using invalid filter values (e.g., unsupported entity types) might result in empty responses or errors.
  • Error Messages:

    • Errors returned from the Bitrix24 API will be surfaced in the node's output if "Continue On Fail" is enabled.
    • Typical error messages include authentication failures, permission denied, or invalid parameters.
  • Resolutions:

    • Verify and refresh authentication credentials.
    • Check network access to Bitrix24 API endpoints.
    • Ensure filter parameters conform to allowed values.

Links and References

Discussion