Skip to main content

Integrations

Endpoints designed for no-code automation platforms like Zapier, Make (Integromat), and n8n. These provide polling triggers and simplified actions for building PDF workflows without writing code.

Test Authentication

GET https://api.getdocuforge.dev/v1/integrations/auth/test Verify that an API key is valid. Used during Zapier/Make connection setup.

Response

{
  "authenticated": true,
  "email": "user@example.com",
  "plan": "pro"
}

Trigger: New Generation

GET https://api.getdocuforge.dev/v1/integrations/triggers/new-generation Polling trigger that returns the most recent PDF generations. Automation platforms call this periodically to detect new items.

Query Parameters

ParameterTypeDefaultDescription
limitinteger10Number of results to return (max 100)

Response

[
  {
    "id": "gen_abc123",
    "template_id": "tmpl_xyz789",
    "input_type": "template",
    "status": "completed",
    "url": "https://cdn.getdocuforge.dev/gen_abc123.pdf",
    "pages": 3,
    "file_size": 45230,
    "generation_time_ms": 1840,
    "error": null,
    "created_at": "2026-03-15T10:30:00.000Z"
  }
]

Trigger: New Template

GET https://api.getdocuforge.dev/v1/integrations/triggers/new-template Polling trigger that returns the most recent templates.

Query Parameters

ParameterTypeDefaultDescription
limitinteger10Number of results to return (max 100)

Response

[
  {
    "id": "tmpl_abc123",
    "name": "Invoice",
    "version": 3,
    "is_public": false,
    "created_at": "2026-03-10T08:00:00.000Z",
    "updated_at": "2026-03-14T15:20:00.000Z"
  }
]

Action: Generate PDF

POST https://api.getdocuforge.dev/v1/integrations/actions/generate Simplified PDF generation action with flat parameters (no nested options object). Designed for easy mapping in automation builders.

Request Body

ParameterTypeRequiredDescription
htmlstring*Raw HTML to convert to PDF
template_idstring*Template ID (tmpl_xxx)
dataobjectNoData to merge into template variables
formatstringNo"A4" (default), "Letter", or "Legal"
orientationstringNo"portrait" (default) or "landscape"
* Either html or template_id is required.

Example

curl -X POST https://api.getdocuforge.dev/v1/integrations/actions/generate \
  -H "Authorization: Bearer df_live_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "tmpl_abc123",
    "data": {
      "company": "Acme Corp",
      "total": 1500
    },
    "format": "A4"
  }'

Response

{
  "id": "gen_abc123",
  "url": "https://cdn.getdocuforge.dev/gen_abc123.pdf",
  "pages": 2,
  "file_size": 45230
}

Errors

All integration endpoints return the same error codes:
StatusCodeDescription
400VALIDATION_ERRORInvalid request body or missing required fields
401UNAUTHORIZEDInvalid or missing API key
403USAGE_LIMIT_EXCEEDEDMonthly PDF limit reached (generate action only)
404NOT_FOUNDTemplate not found (generate action only)
429RATE_LIMITEDToo many requests
500INTERNAL_ERRORServer error