Formstack Documents
App · 24 actions
Create document templates and data routes, merge data, and convert or process PDF files.
Actions
| Action | What it does |
|---|---|
| Combine | Combine. |
| Compress pdf | Compress pdf. |
| Convert to pdf | Convert to pdf. |
| Copy document | Copy document. |
| Create document | Create document. |
| Create route | Create route. |
| Delete document | Delete document. |
| Delete route | Delete route. |
| Download template | Retrieve the uploaded source template as base64, with its file type and last update time. |
| Encrypt pdf | Encrypt pdf. |
| Get document | Get document. |
| Get route | Get route. |
| List document deliveries | List document deliveries. |
| List document fields | List document fields. |
| List documents | List documents. |
| List route deliveries | List route deliveries. |
| List route fields | List route fields. |
| List route rules | List route rules. |
| List routes | List routes. |
| Merge document | Merge document. |
| Merge route | Merge route. |
| Split pdf | Split pdf. |
| Update document | Update document. |
| Update route | Update route. |
Combine
Combine.
Inputs
- Files
fileslistRequired - Files.
- Output
outputtextRequired - Output.One of:
pdf,docx.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"content_base64": "example",
"content_type": "example"
}
}Compress pdf
Compress pdf.
Inputs
- File
fileobjectRequired - Name plus either a public URL or base64 contents.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"content_base64": "example",
"content_type": "example"
}
}Convert to pdf
Convert to pdf.
Inputs
- File
fileobjectRequired - Name plus either a public URL or base64 contents.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"content_base64": "example",
"content_type": "example"
}
}Copy document
Copy document.
Inputs
- Document
document_idtextRequired - Choose a document or use its ID.
- Name
nametextRequired - Name.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"fields": [],
"html": "example",
"id": "example",
"key": "example",
"name": "example",
"output": "example",
"type": "example",
"url": "example"
}
}Create document
Create document.
Inputs
- Name
nametextRequired - Name.
- Type
typetextRequired - Type.One of:
html,pdf,docx,xlsx,pptx. - Output
outputtextRequired - Output.One of:
pdf,docx,xlsx,pptx,email. - Html
htmltext - Html.
- File url
file_urltext - File url.
- File contents
file_contentstext - File contents.
- Output name
output_nametext - Output name.
- Folder
foldertext - Folder.
- Size width
size_widthnumber - Size width.At least 0.
- Size height
size_heightnumber - Size height.At least 0.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"fields": [],
"html": "example",
"id": "example",
"key": "example",
"name": "example",
"output": "example",
"type": "example",
"url": "example"
}
}Create route
Create route.
Inputs
- Name
nametextRequired - Name.
- Rules
ruleslistRequired - Rules.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"id": "example",
"key": "example",
"name": "example",
"url": "example"
}
}Delete document
Delete document.
Inputs
- Document
document_idtextRequired - Choose a document or use its ID.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"success": 1
}
}Delete route
Delete route.
Inputs
- Route
route_idtextRequired - Choose a data route or use its ID.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"success": 1
}
}Download template
Retrieve the uploaded source template as base64, with its file type and last update time.
Inputs
- Document
document_idtextRequired - Choose a document or use its ID.
Outputs
dataobject- The uploaded template file.
Example output
{
"data": {
"contents": "example",
"last_update": "example",
"type": "example"
}
}Encrypt pdf
Encrypt pdf.
Inputs
- File
fileobjectRequired - Name plus either a public URL or base64 contents.
- Password
passwordtextRequired - Password.
- User password
user_passwordtext - User password.
- Permissions
permissionslist - Permissions.One or more of:
Printing,DegradedPrinting,ModifyContents,Assembly,CopyContents,FillIn,AllFeatures.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"content_base64": "example",
"content_type": "example"
}
}Get document
Get document.
Inputs
- Document
document_idtextRequired - Choose a document or use its ID.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"fields": [],
"html": "example",
"id": "example",
"key": "example",
"name": "example",
"output": "example",
"type": "example",
"url": "example"
}
}Get route
Get route.
Inputs
- Route
route_idtextRequired - Choose a data route or use its ID.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"id": "example",
"key": "example",
"name": "example",
"url": "example"
}
}List document deliveries
List document deliveries.
Inputs
- Document
document_idtextRequired - Choose a document or use its ID.
Outputs
datalist- Returned value.
Example output
{
"data": []
}List document fields
List document fields.
Inputs
- Document
document_idtextRequired - Choose a document or use its ID.
Outputs
datalist- Returned value.
Example output
{
"data": []
}List documents
List documents.
Inputs
- Search
searchtext - Search.
- Folder
foldertext - Folder.
Outputs
datalist- Returned value.
Example output
{
"data": []
}List route deliveries
List route deliveries.
Inputs
- Route
route_idtextRequired - Choose a data route or use its ID.
Outputs
datalist- Returned value.
Example output
{
"data": []
}List route fields
List route fields.
Inputs
- Route
route_idtextRequired - Choose a data route or use its ID.
Outputs
datalist- Returned value.
Example output
{
"data": []
}List route rules
List route rules.
Inputs
- Route
route_idtextRequired - Choose a data route or use its ID.
Outputs
datalist- Returned value.
Example output
{
"data": []
}List routes
List routes.
Inputs
None.
Outputs
datalist- Returned value.
Example output
{
"data": []
}Merge document
Merge document.
Inputs
- Document
document_idtextRequired - Choose a document or use its ID.
- Data
dataobjectRequired - Data.
- Test
testtrue/false - Test.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"success": 1
}
}Merge route
Merge route.
Inputs
- Route
route_idtextRequired - Choose a data route or use its ID.
- Data
dataobjectRequired - Data.
- Test
testtrue/false - Test.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"success": 1
}
}Split pdf
Split pdf.
Inputs
- File
fileobjectRequired - Name plus either a public URL or base64 contents.
- Extract
extracttext - Page ranges to extract, for example 1-3,5.
- Remove
removetext - Page ranges to remove.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"content_base64": "example",
"content_type": "example"
}
}Update document
Update document.
Inputs
- Document
document_idtextRequired - Choose a document or use its ID.
- Name
nametext - Name.
- Output
outputtext - Output.One of:
pdf,docx,xlsx,pptx,email. - Html
htmltext - Html.
- File url
file_urltext - File url.
- File contents
file_contentstext - File contents.
- Output name
output_nametext - Output name.
- Folder
foldertext - Folder.
- Size width
size_widthnumber - Size width.At least 0.
- Size height
size_heightnumber - Size height.At least 0.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"fields": [],
"html": "example",
"id": "example",
"key": "example",
"name": "example",
"output": "example",
"type": "example",
"url": "example"
}
}Update route
Update route.
Inputs
- Route
route_idtextRequired - Choose a data route or use its ID.
- Name
nametext - Name.
- Rules
ruleslist - Rules.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"id": "example",
"key": "example",
"name": "example",
"url": "example"
}
}