Skip to main content

Integration with Zapier


The DynamicPDF API provides integration with the Zapier platform so you can easily integrate PDF capabilities into your existing Zapier workflows.

Authentication

All authentication is through a top-level field named DynamicPDF API Key.

info

Refer to Apps and API Keys for more information on assigning an API key.

  • Use a DynamicPDF API Key starting with DP. (example: DP.R2mx...).
  • Enter the key into the DynamicPDF API Key field when configuring the module.
  • Credentials are stored securely by Zapier and applied via Authorization: Bearer header.
  • No OAuth or refresh tokens are required.
  • Authentication is validated by performing a test PDF request during connection setup

Actions

The DynamicPDF API Zapier App includes the following actions.

tip

Be certain to check-out the tutorial: Using the DynamicPDF API Zapier App.


dlex-layout (local resources)

Render a PDF by submitting a local DLEX template, layout JSON file, and optional resource files as multipart form-data. Use this action when your layout references external resources such as images, fonts, or data files (dlex-layout).

FieldTypeNote
LayoutData File NametextUsually layout.json or instructions.json
LayoutData File (data)fileJSON layout data mapped from a prior step
Resourcesline-item filesOptional resource files used by the layout
Resource File NametextResource filename
Resource File DatafileBinary resource file

dlex-layout (DlexPath)

Render a PDF by referencing a DLEX template already stored in DynamicPDF API cloud storage and supplying a layout JSON file (dlex-layout).

FieldTypeNote
LayoutData File NametextUsually layout.json or instructions.json
LayoutData File (data)fileJSON layout data
DlexPathtextPath to stored DLEX file (example: /templates/invoice.dlex)

image-info

Analyze an image file and return metadata and technical details as JSON (image-info).

FieldTypeNote
Image BinaryfileBinary image file
Image MIME Typeenumimage/png, image/jpeg, image/gif, image/bmp, image/tiff

pdf-image

Rasterize a PDF and return page images and related rendering data as JSON (pdf-image).

FieldTypeNote
PDF File NametextName of the PDF file
PDF File DatafileBinary PDF
Start page number (sp)number1-based page number
Page count (pc)numberNumber of pages to convert
Image format (if)enumPNG, JPEG, GIF, BMP, TIFF
Quality (qt)number1–100
Dithering percent (dp)number1–100
Dithering algorithm (da)enumFloyd-Steinberg, Bayer, None
Color format (cf)enumRGB, Monochrome, Indexed
Multi-page (mp)booleanEnable multi-page image formats
DPI / size optionsnumberDPI, fixed, max, or percentage scaling

pdf-info

Extract PDF metadata, document properties, and page details as structured JSON (pdf-info).

FieldTypeNote
PDF BinaryfileBinary PDF file

pdf (JSON)

Generate a PDF using a JSON instructions document that defines inputs and merge operations (pdf - JSON).

FieldTypeNote
Instructions.jsonfileJSON instructions defining PDF operations

pdf (multipart-form)

Generate a PDF using an instructions document plus optional resource files (pdf - multipart form).

FieldTypeNote
Instructions filenametextName of the instructions file
Instructions File (data)fileInstructions.json
Resourcesline-item filesOptional images, fonts, or PDFs
Resource File NametextResource filename
Resource File DatafileBinary resource file

pdf-security-info

Extract PDF security settings, permissions, and encryption details as JSON (pdf-security-info).

FieldTypeNote
PDF BinaryfileBinary PDF file

pdf-xmp

Extract XMP metadata from a PDF and return it as XML (pdf-xmp).

FieldTypeNote
PDF BinaryfileBinary PDF file

pdf-text

Extract text content from a PDF and return it as structured JSON (pdf-text).

FieldTypeNote
PDF BinaryfileBinary PDF
Start PagenumberStarting page number
Page CountnumberNumber of pages to extract
Text OrderenumStream, Visible, Visible Extra Space

Input Requirements & File Handling

  • Layout and instruction files must be valid .json documents.
  • Zapier file inputs must be mapped from upstream steps (Drive, Email, Webhooks, Code, etc.).
  • Binary file fields must be mapped directly; base64 is not required.
  • Multipart actions require both a filename field and a file field (Zapier requirement).
  • Multiple PDFs, images, or resource files may be included as line-items.

Usage Notes

  • PDF generation actions support both JSON-only and multipart workflows.
  • Analysis actions (pdf-info, pdf-text, pdf-xmp, pdf-security-info, image-info) accept raw binary uploads.
  • Outputs are returned as structured JSON or binary PDF files.
  • Results can be routed to storage, email, OCR, signing, or downstream automation steps.
  • All processing is performed by the DynamicPDF API.