Overview
The Output.Rocks Document Renderer node generates documents from templates using the Output.Rocks API. It allows users to specify a template, provide data and optional metadata, select an output format (PDF, TXT, or HTML), and optionally set up a webhook for asynchronous processing. This node is useful in scenarios where automated document generation is required, such as creating invoices, reports, certificates, or any templated documents within n8n workflows.
Practical examples:
- Automatically generating PDF invoices from order data.
- Creating personalized certificates in HTML format for event participants.
- Producing text-based reports from structured input data.
Properties
Name | Type | Meaning |
---|---|---|
Format | options | Document format to generate: PDF, TXT, or HTML. |
Webhook Identifier | string | Optional identifier for a webhook to receive document status updates. |
Template Identifier | string | Required. The unique identifier of the template to use for rendering. |
Metadata | string | Optional. Additional metadata in JSON format to include with the request. |
Data | string | Required. Main data in JSON format used to populate the template. |
Webhook Waiting URL | hidden | Internal. Used by n8n for webhook resumption; not user-configurable. |
Output
The node outputs a json
object containing the response from the Output.Rocks API after document rendering. The structure typically includes:
{
"id": "string", // Unique identifier for the rendering job
"status": "string", // Status of the rendering (e.g., 'completed', 'pending')
"url": "string", // URL to download the generated document
"format": "string", // Format of the generated document ('pdf', 'txt', 'html')
"template": "string", // Template identifier used
"metadata": { ... }, // Any metadata returned by the API
// ...other fields as provided by Output.Rocks API
}
If the node is configured to wait for a webhook, the output may also reflect the asynchronous status or result.
Dependencies
- External Service: Requires access to the Output.Rocks API.
- API Key: Needs an
outputRocksApi
credential configured in n8n. - Network Access: n8n instance must be able to reach
https://app.staging.output.rocks/api/renderings
.
Troubleshooting
Common Issues:
- Invalid JSON in Data or Metadata: If the
Data
orMetadata
fields are not valid JSON strings, the node will throw a parsing error. - Missing Required Fields: Omitting the
Template Identifier
orData
will cause the node to fail. - Authentication Errors: Incorrect or missing
outputRocksApi
credentials will result in authentication failures. - Webhook Misconfiguration: If a webhook identifier is provided but not properly set up, you may not receive status updates.
Error Messages:
"Unexpected token ... in JSON at position ..."
: Indicates invalid JSON in theData
orMetadata
fields. Ensure these fields contain valid JSON strings."Request failed with status code 401"
: Authentication issue. Check your API key configuration."Template not found"
: The specified template identifier does not exist on Output.Rocks.