Plumsail Documents

Plumsail Documents connector allows you to set up automated document generation and conversion. The connector provides a wide range of actions to manipulate PDF documents and PDF forms. Create documents from templates, convert to PDF, split and merge PDF files, protect them, read PDF forms, and more - all you need to automate documents in one connector. Find more information at https://plumsail.com/documents

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Support
URL https://plumsail.com
Email support@plumsail.com
Connector Metadata
Publisher Plumsail Inc
Website https://plumsail.com
Privacy policy https://plumsail.com/privacy-policy/
Categories Productivity;Content and Files

Generate documents in Microsoft Power Automate, Azure Logic Apps or PowerApps

Register account

First of all, you need to register Plumsail Account. This account is used to manage Plumsail Documents, Plumsail Actions and Plumsail Forms products.

It is better to use your active email address. The subscription will be linked to this address.

If you already have an account, just sign in to account.plumsail.com.

Generate API key

You need to navigate to the "API Keys" section and click "Add new".

Once you created an API key, you can see your key right in the "Secret" column. You can also change a name of a key by clicking on it in the "Name" column:

API keys

Create as many keys as you need, for example, for using with different Power Automate (Microsoft Flow) accounts. If you don't need a key anymore you can delete it, please make sure that the key is not used anymore.

Now you can copy and use it in:

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Shareable

Default

Applicable: All regions

Parameters for creating connection.

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name Type Description Required
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 1200 60 seconds

Actions

Add a watermark to PDF

Adds a text watermark to PDF

Compress PDF document

Compress pdf document size if possible

Convert Csv to Excel

Converts CSV file to Excel

Convert DOC to DOCX

It takes DOC document and converts it to DOCX

Convert DOCX to PDF

It takes DOCX document and converts it to PDF

Convert HTML to PDF

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

Convert PDF to Image

It takes PDF document and converts it to Image (jpeg, png, gif, bmp)

Convert PPT to PPTX

It takes PPT document and converts it to PPTX

Convert PPTX to PDF

It takes PPTX document and converts it to PDF

Convert XLS to XLSX

It takes XLS document and converts it to XLSX

Convert XLSX to PDF

It takes XLSX document and converts it to PDF

Create document from DOCX template

Create document from DOCX template. More information: https://plumsail.com/docs/actions/v1.x/document-generation/docx/index.html

Create document from PPTX template

Create document from PPTX template.

Create document from XLSX template

Create document from XLSX template. More information: https://plumsail.com/docs/actions/v1.x/document-generation/xlsx/index.html

Create HTML from template

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

Extract text from PDF document

It takes PDF document and extracts text to Raw or HTML format

Fill in PDF Form

Filling out PDF form by provided data

Fill merge fields in DOCX document

It takes a DOCX document with merge fields and replaces them by specified data. The keys in data object should be the same as names of MergeFields (Express block) in document

Get Form from PDF

Returns fillable form data from PDF as JSON

Get information about PDF protection

Returns information whether the document is password protected

Get Profile Info

Returns information about current user and license

Merge Docx

It takes an array of Docx documents and merge it into single file

Merge PDF

It takes an array of PDF documents and merge it

Parse CSV

It works like Parse JSON but for CSV file

Protect PDF document

Adds passwords, copy-, printing-, and other protections to PDF file

Regular Expression Match

Searches an input string for all occurrences of a regular expression and returns all the matches. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

Regular Expression Replace

In a specified input string, replaces all strings that match a regular expression pattern with a specified replacement string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

Regular Expression Test

Indicates whether the regular expression specified in the Regex constructor finds a match in a specified input string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

Split PDF

It takes PDF document and split it

Start document generation process

Fill a template related to the selected process with the JSON data

Start document generation process with json

Fill a template related to the selected process with the JSON data

Add a watermark to PDF

Adds a text watermark to PDF

Parameters

Name Key Required Type Description
Type
type True string

The type of the watermark

request
request True dynamic

Returns

Compress PDF document

Compress pdf document size if possible

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Raw content of PDF document

Password
password string

Password to open PDF file

Returns

Result file
binary

Convert Csv to Excel

Converts CSV file to Excel

Parameters

Name Key Required Type Description
Content of CSV document
content True byte

Content of CSV document

Delimiter
delimiter string

Delimiter of columns (by default it is just comma)

Locale
locale string

The locale that will be applyed to the document

Limit
limit integer

Returns the first "n" rows

Use first line as headers
hasHeaderRecords boolean

If set as "true" when headers will be read from a first line.

Returns

Result file
binary

Convert DOC to DOCX

It takes DOC document and converts it to DOCX

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Content of document that should be converted

Returns

Result file
binary

Convert DOCX to PDF

It takes DOCX document and converts it to PDF

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Content of document that should be converted

Returns

Convert HTML to PDF

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

Parameters

Name Key Required Type Description
Source HTML
html True string

HTML markup that should be converted to PDF

Engine
engine string

Conversion engine

Paper Size
size string

Can be A4,A5 etc...

Orientation
orientation string

Portrait vs Landscape

Margins
margins string

The page margins. The syntax is the same as in CSS. Example: 25 50 75 100.

Header HTML
headerHtml string

Only Classic engine - HTML markup that should be added as a header

Footer HTML
footerHtml string

Only Classic engine - HTML markup that should be added as a footer

Returns

Convert PDF to Image

It takes PDF document and converts it to Image (jpeg, png, gif, bmp)

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Raw content of PDF document

Start Page
startPage integer

The first page to start extraction (1 based)

End Page
endPage integer

The last page to extract (inclusive)

Pages
pages string

Page numbers for extraction separated by ';' (only this pages will be extracted)

Image Format
format string

The format of the result image

DPI
dpi integer

The resolution of the result image

Password
password string

Password to decrypt document

Returns

Convert PPT to PPTX

It takes PPT document and converts it to PPTX

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Content of document that should be converted

Returns

Result file
binary

Convert PPTX to PDF

It takes PPTX document and converts it to PDF

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Content of document that should be converted

Returns

Result file
binary

Convert XLS to XLSX

It takes XLS document and converts it to XLSX

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Content of document that should be converted

Returns

Result file
binary

Convert XLSX to PDF

It takes XLSX document and converts it to PDF

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Content of document that should be converted

Returns

Result file
binary

Create document from DOCX template

Create document from DOCX template. More information: https://plumsail.com/docs/actions/v1.x/document-generation/docx/index.html

Parameters

Name Key Required Type Description
Template file
documentContent True binary

Content of the template

Template data
data True object

JSON data that should be applied to the template

Document output type
outputType True string

The required document type

Locale
locale string

The locale that will be applyed to the document

Time zone
timezone string

The time zone of the document

Returns

Result file
binary

Create document from PPTX template

Create document from PPTX template.

Parameters

Name Key Required Type Description
Template file
documentContent True binary

Content of the template

Template data
data True object

JSON data that should be applied to the template

Document output type
outputType True string

The required document type

Locale
locale string

The locale that will be applyed to the document

Time zone
timezone string

The time zone of the document

Returns

Create document from XLSX template

Create document from XLSX template. More information: https://plumsail.com/docs/actions/v1.x/document-generation/xlsx/index.html

Parameters

Name Key Required Type Description
Template file
documentContent True binary

Content of the template

Template data
data True object

JSON data that should be applied to the template

Document output type
outputType True string

The required document type

Locale
locale string

The locale that will be applyed to the document

Time zone
timezone string

The time zone of the document

Returns

Result file
binary

Create HTML from template

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

Parameters

Name Key Required Type Description
Source HTML
html True byte

Text HTML template or HTML file template

Template data
data True object

JSON data that should be applied to the template

Locale
locale string

The locale that will be applyed to the document

Time zone
timezone string

The time zone of the document

Returns

Extract text from PDF document

It takes PDF document and extracts text to Raw or HTML format

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Raw content of PDF document

Start Page
startPage integer

The first page to start extraction (1 based)

End Page
endPage integer

The last page to extract (inclusive)

Result Type
resultType string

Raw or HTML

Password
password string

Password to decrypt document

Returns

Fill in PDF Form

Filling out PDF form by provided data

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Raw content of PDF document

JSON data
jsonData True object

The data that will be used to fill out the form

Lock form fields
lockFormFields boolean

Disable fields editing after filling them

Password
password string

Password to open PDF file

Returns

Fill merge fields in DOCX document

It takes a DOCX document with merge fields and replaces them by specified data. The keys in data object should be the same as names of MergeFields (Express block) in document

Parameters

Name Key Required Type Description
DOCX document content
docxDocument True byte

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

Template data
data True object

JSON data that should be applied to the template

Returns

Get Form from PDF

Returns fillable form data from PDF as JSON

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Raw content of PDF document

Password
password string

Password to decrypt document

Returns

response
object

Get information about PDF protection

Returns information whether the document is password protected

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Raw content of PDF document

Returns

Get Profile Info

Returns information about current user and license

Returns

Merge Docx

It takes an array of Docx documents and merge it into single file

Parameters

Name Key Required Type Description
Content
documentsContents True array of binary

The array of raw content of Docx documents

Apply header and footer
applyHeaderAndFooter True boolean

Applies the header and footer from the first document to all the others

Returns

Merge PDF

It takes an array of PDF documents and merge it

Parameters

Name Key Required Type Description
Content
documentsContents True array of binary

The array of raw content of PDF documents

Returns

Result file
binary

Parse CSV

It works like Parse JSON but for CSV file

Parameters

Name Key Required Type Description
Content of CSV document
content True byte

Content of CSV document

Delimiter
delimiter string

Delimiter of columns (by default it is just comma)

Locale
locale string

The locale that will be applyed to the document

Limit
limit integer

Returns the first "n" rows

Headers
headers True string

Comma separated list of headers in the same order as CSV columns

Skip first line
skipFirstLine boolean

Select "Yes" if your CSV has headers as a first line.

Returns

The outputs of this operation are dynamic.

Protect PDF document

Adds passwords, copy-, printing-, and other protections to PDF file

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Raw content of PDF document

Enable printing
allowPrinting True boolean

Protect the PDF file from being printed out

Enable modification
allowModification True boolean

Protect the PDF file from being edited

Enable extract data
allowExtract True boolean

Allows extraction of text, images, and other media from the PDF file

Enable annotate
allowAnnotate True boolean

Allows annotation (e.g. comments, form fill-in, signing) of the PDF file

PDF owner password
newOwnerPassword string

Enter an optional owner password here. This password can be used to disable document restrictions

PDF user password
newUserPassword string

Enter an optional user password here. Each time an user opens the PDF he will be asked for this password. If you do not want a password prompt then leave this field blank

Password
password string

Password to decrypt document

Returns

Regular Expression Match

Searches an input string for all occurrences of a regular expression and returns all the matches. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

Parameters

Name Key Required Type Description
Pattern
pattern True string

Regular expression pattern

Text
text True string

String to search for matches

Returns

The outputs of this operation are dynamic.

Regular Expression Replace

In a specified input string, replaces all strings that match a regular expression pattern with a specified replacement string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

Parameters

Name Key Required Type Description
Pattern
pattern True string

Regular expression pattern

Text
text True string

String to search for matches

Replacement
replacement string

Replacement string

Returns

Regular Expression Test

Indicates whether the regular expression specified in the Regex constructor finds a match in a specified input string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

Parameters

Name Key Required Type Description
Pattern
pattern True string

Regular expression pattern

Text
text True string

String to search for matches

Returns

Split PDF

It takes PDF document and split it

Parameters

Name Key Required Type Description
Document content
documentContent True byte

Raw content of PDF document

Start Page
startPage integer

The first page to start split (1 based)

End Page
endPage integer

The last page to split (inclusive)

Split At Page
splitAtPage integer

Number of pages per partition

Password
password string

Password to decrypt document

Returns

Start document generation process

Fill a template related to the selected process with the JSON data

Parameters

Name Key Required Type Description
Process name
processId True string

The name of process to be started

data
data True dynamic

Returns

Result file
binary

Start document generation process with json

Fill a template related to the selected process with the JSON data

Parameters

Name Key Required Type Description
Process name
processId True string

The name of process to be started

object

Returns

Result file
binary

Triggers

Process finished

Creates a webhook that runs when the process is finished

Process finished

Creates a webhook that runs when the process is finished

Parameters

Name Key Required Type Description
Process name
processId True string

The name of process to be started

Returns

The outputs of this operation are dynamic.

Definitions

ApplyHtmlTemplateResponse

Name Path Type Description
Result HTML
htmlResult string

Raw HTML result

BooleanResultResponse

Name Path Type Description
IsSuccess
isSuccess boolean

DocumentProcessingResponse

Name Path Type Description
Result file
fileContent byte

The result as a file

DocumentsArrayResponse

Name Path Type Description
Result files
resultFilesContents array of byte

The array of raw content of result files

GetPdfProtectionInfoResponse

Name Path Type Description
isPasswordProtected
isPasswordProtected boolean

LicenseInfo

Name Path Type Description
type
type integer
credits
credits integer
additionalCredits
additionalCredits integer
expirationDate
expirationDate date-time

ProfileInfo

Name Path Type Description
name
name string
email
email string
licenseStatus
licenseStatus string
licenseInfo
licenseInfo LicenseInfo

StringResultResponse

Name Path Type Description
Result
result string

binary

This is the basic data type 'binary'.

object

This is the type 'object'.