Documerge

Merge data into document templates with Documerge.

On this page

Connect
Call it from a workflow
Actions (5)
combine_files
convert_file_to_pdf
create_data_route_merge
create_document_merge
split_pdf
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("documerge", "combine_files", {
    "output": "pdf",
    "files": []
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Documerge answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "documerge-combine-files",
  name: "Documerge: Combine Files",
  description: "Calls Documerge when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("documerge", {
      "action": "combine_files",
      "output": "pdf",
      "files": []
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/documerge/combine_files" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"output":"pdf","files":[]}}'

Actions

combine_filesin catalog

Combine Files. Combine multiple files into a single PDF or DOCX

Input	Type	Description
`output`required	one of "pdf" \| "docx"	The format of the combined file
`files`required	array	Array of file identifiers to combine
`name`optional	text	Name for the combined file
`url`optional	text	URL of a file to include (must be a valid URL)
`contents`optional	long text	Additional content to include

convert_file_to_pdfin catalog

Convert File to PDF. Convert a given file to PDF

Input	Type	Description
`fileName`required	text	Name of the file to convert
`fileUrl`optional	text	URL of the file to convert (must be a valid URL)
`contents`optional	long text	Additional content to include

create_data_route_mergein catalog

Create Data Route Merge. Send data to your Data Route URL

Input	Type	Description
`routeKey`required	text	The key of the data route to merge
`fields`optional	object	Field data to merge into the document

create_document_mergein catalog

Create Document Merge. Send data to your Merge URL

Input	Type	Description
`documentKey`required	text	The key of the document to merge
`fields`optional	object	Field data to merge into the document

split_pdfin catalog

Split PDF. Extract or remove specific pages from a PDF file

Input	Type	Description
`fileName`required	text	Name of the PDF file
`fileUrl`optional	text	URL of the PDF file (must be a valid URL)
`contents`optional	long text	Base64 encoded file contents
`extract`optional	array	Page numbers or ranges to extract (e.g., "1", "2-5", "1, 3-5")
`remove`optional	array	Page numbers or ranges to remove (e.g., "1", "2-5", "1, 3-5")

Details

Id: documerge
Category: Other
Tags: documents, templates, merge, pdf
Package: @activepieces/piece-documerge@0.1.4
Tier: Community