TemplateFox icon

TemplateFox

Generate PDFs from templates and manipulate PDFs using the TemplateFox API

Generate PDF (Async)

AI-generated

Summary

Queue an asynchronous PDF generation job from a selected template and provide template data either as individual fields or raw JSON. Optionally configure job options such as expiration, filename, PDF variant, version, S3 storage, and receive job completion notifications via webhook.

Inputs

  • Template Name or ID (required) — Select the template to generate the PDF from. You can choose from the list of templates or specify an ID using an expression.
  • Data Input Mode (required) — Choose how to provide data for the template: either map individual template fields or provide raw JSON data, which is recommended for complex arrays.
  • Template Fields (required) — When using 'Use Template Fields' mode, specify values for individual template variables. Fields are dynamically loaded based on the selected template.
  • JSON Data (required) — When using 'JSON' mode, provide raw JSON data for template variables, allowing complex structures and arrays.
  • Options — Configure optional settings including the expiration time (in seconds) for the PDF URL, custom filename (without extension), PDF/A variant for archival compliance, specific template version (tagged or draft), and whether to store the resulting PDF on S3 with optional custom filepath and bucket.
  • Webhook — For asynchronous operation, optionally specify a HTTPS webhook URL to receive a POST notification upon job completion or failure, with an optional HMAC-SHA256 secret to verify payloads.

Output shape

a single JSON object containing the queued PDF job details, including a job ID for tracking generation status.

Use the returned job ID with the 'Get PDF Job' operation to check job status or retrieve the generated PDF once completed. If a webhook URL is provided, the job notification will be sent to that address when processing finishes.

Links

Discussion