Create Submission
formstack.create_submission
ActionBusiness appsconnection required
Calls the Formstack API with the connection's credentials.
Record a new submission on a form from a list of field values.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Formstack
- Secret shape
- the Personal Access Token, or {"api_key": "fs_pat_…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
form_id The numeric id of the Formstack form to act on. | string | Yes | — | — | 2721234 |
fields The field values to write, as a list of {"id", "value"} objects where id is the numeric Formstack field id. | array | Yes | — | ≥ 1 characters; array of object | [{"id":"123456","value":"jane@example.com"}] |
read Mark the submission as already read instead of leaving it unread. | boolean | No | false | — | — |
remote_addr IP address to record against the submission, when you have one. | string | No | — | — | — |
user_agent Browser user agent string to record against the submission. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"fields": [
{
"id": "123456",
"value": "jane@example.com"
}
],
"form_id": "2721234",
"read": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The numeric id of the submission. | number | — |
formId The numeric id of the form the submission belongs to. | number | — |
timestamp When Formstack recorded the submission. | string | — |
userAgent The browser user agent string of the submitter. | string | — |
remoteAddr The IP address the submission arrived from. | string | — |
paymentStatus Payment status, when the form takes payments. | string | — |
data One row per field, each with field, label, type and displayValue. | array | — |
{
"data": [],
"formId": 0,
"id": 0,
"paymentStatus": "",
"remoteAddr": "",
"timestamp": "",
"userAgent": ""
}See Create Submission run in a workflow.
In a technical demo we add the Formstack connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.