Document Step
Generates documents without collecting signatures. Use this step to place fields onto static or dynamic templates that will be filled with workflow data and rendered to files (e.g., PDFs).
Top-level properties
| name | type | required | constraints | |
|---|---|---|---|---|
name | string | yes | Human-friendly name of this document set | |
type | string | yes | enum: dynamic, static | Whether templates are generated dynamically or from static assets |
templates | array | yes | items: template | One or more document templates to render |
Template
| name | type | required | |
|---|---|---|---|
name | string | yes | Template display name |
fileId | string | yes | Identifier of the base file or template to render |
fields | array | yes | Positioned fields that will be populated |
Field
| name | type | required | constraints | |
|---|---|---|---|---|
id | string | yes | Field id for reference | |
fieldSubType | string | yes | enum: text, checkbox, radio | Visual subtype of the positioned field |
wrapText | boolean | yes | default: false | Whether text wraps within the bounding box |
required | boolean | yes | default: false | Whether a value must be supplied |
xPosition | number | no | Horizontal position on the page (units defined by renderer) | |
yPosition | number | no | Vertical position on the page | |
pageNumber | number | yes | Page index to place the field on | |
width | number | no | Bounding box width | |
height | number | no | Bounding box height | |
fontSize | number | no | Font size for text fields | |
optionValue | string | no | Specific option value for radio/checkbox toggles | |
value | string | no | Static value to inject (for text fields) | |
radioGroupId | string | no | Identifier to group related radio options | |
fieldType | string | yes | enum: form_field | Fixed type indicating a standard form field |
Example (JSON)
{
"name": "Onboarding Packet",
"type": "dynamic",
"templates": [
{
"name": "Packet",
"fileId": "file_123",
"fields": [
{
"id": "fld-001",
"fieldSubType": "text",
"wrapText": false,
"required": true,
"xPosition": 120,
"yPosition": 240,
"pageNumber": 1,
"width": 300,
"height": 24,
"fontSize": 12,
"optionValue": "",
"value": "",
"radioGroupId": "",
"fieldType": "form_field"
},
{
"id": "fld-002",
"fieldSubType": "checkbox",
"wrapText": false,
"required": false,
"xPosition": 120,
"yPosition": 300,
"pageNumber": 1,
"width": 12,
"height": 12,
"fontSize": 10,
"optionValue": "yes",
"value": "yes",
"radioGroupId": "",
"fieldType": "form_field"
},
{
"id": "fld-003",
"fieldSubType": "radio",
"wrapText": false,
"required": false,
"xPosition": 120,
"yPosition": 340,
"pageNumber": 2,
"width": 12,
"height": 12,
"fontSize": 10,
"optionValue": "A",
"value": "A",
"radioGroupId": "grp-choices",
"fieldType": "form_field"
}
]
}
]
}Updated 22 days ago
