Connectors Reference

Plumsail Documents

The API allows you to create documents from templates (DOCX or HTML file), convert it to PDF and many more. Visit https://plumsail.com/actions for more information.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

FlowV1DocumentsJobsApplyDocxPost (ApplyDocxTemplateRequest request)

Create document from DOCX template

FlowV1DocumentsJobsApplyHtmlPost (ApplyHtmlFlowTemplateRequest request)

Create HTML from template

FlowV1DocumentsJobsHtml2PdfPost (Html2PdfFlowRequest request)

Convert HTML to PDF

FlowV1DocumentsJobsDocx2PdfPost (Docx2PdfRequest request)

Convert of DOCX to PDF

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

ApplyDocxTemplateRequest

 

ApplyHtmlFlowTemplateRequest

 

ApplyHtmlTemplateResponse

 

DocumentProcessingResponse

 

Docx2PdfRequest

 

Html2PdfFlowRequest

 

 

Actions:

FlowV1DocumentsJobsApplyDocxPost

Summary: Create document from DOCX template

Description: It takes a template and replaces express block MergeField to specified data. The keys in data object should be the same as names of MergeFields (Express block) in document.

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsApplyDocxPost (ApplyDocxTemplateRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

ApplyDocxTemplateRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 

FlowV1DocumentsJobsApplyHtmlPost

Summary: Create HTML from template

Description: It takes input HTML template string or file and replaces special {{Tokens}} by specified data. We use Mustache framework for templates internally. More information about templates in Mustache docs: http://mustache.github.io/mustache.5.html.

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsApplyHtmlPost (ApplyHtmlFlowTemplateRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

ApplyHtmlFlowTemplateRequest

 

 

True

 

Returns:

          Type:ApplyHtmlTemplateResponse

 

FlowV1DocumentsJobsHtml2PdfPost

Summary: Convert HTML to PDF

Description: It takes HTML markup, renders it and converts to PDF document.

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsHtml2PdfPost (Html2PdfFlowRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Html2PdfFlowRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 

FlowV1DocumentsJobsDocx2PdfPost

Summary: Convert of DOCX to PDF

Description: It takes DOCX document and converts it to PDF.

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsDocx2PdfPost (Docx2PdfRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Docx2PdfRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 


 

ApplyDocxTemplateRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

docxDocument

string(byte)

DOCX document content

Raw content of docx document template. MergeField names should be the same as keys in template data.

data

Data

Template data

JSON data that should be applied to the template.

 

Data

Summary: Template data

Description: JSON data that should be applied to the template.

 

          Properties:

Name

Type

Summary

 


 

ApplyHtmlFlowTemplateRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

html

string(byte)

Source HTML

Text HTML template or HTML file template.

data

Data

Template data

JSON data that should be applied to the template.

 

Data

Summary: Template data

Description: JSON data that should be applied to the template.

 

          Properties:

Name

Type

Summary

 


 

ApplyHtmlTemplateResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

htmlResult

string

Result HTML

Raw HTML result.


 

DocumentProcessingResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileContent

string(byte)

Result file

Raw content of the result file.


 

Docx2PdfRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Document content

Content of document that should be converted to PDF.


 

Html2PdfFlowRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

html

string(byte)

Source HTML

HTML markup that should be converted to PDF.

size

string

Paper Size

Can be A4,A5 etc...  Values: [A4, Letter, LetterSmall, Tabloid, Ledger, Legal, Statement, Executive, A2, A3, A4Small, A5, B4, B5]

orientation

string

Orientation

Portrait vs Landscape.  Values: [Portrait, Landscape]