Create Form
form_io.create_form
ActionBusiness appsconnection required
Calls the Form.io API with the connection's credentials.
Create a form or a resource on the project from a component list.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Form.io
- Secret shape
- {"api_key": "…"} for a project API key, or {"jwt_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, 4 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 |
|---|---|---|---|---|---|
title Human-readable name shown to people filling the form in. | string | Yes | — | — | Race Registration |
name Machine name of the form, used internally by Form.io. | string | Yes | — | — | raceRegistration |
path API path the form is reachable at within the project. | string | Yes | — | — | raceregistration |
components The form's components, as a JSON array of component objects. | array | Yes | — | ≥ 1 characters; array of object | [{"key":"firstName","label":"First name","type":"textfield"}] |
form_type Whether to create a form or a reusable resource. | string | No | form | one of "form", "resource" | — |
display How the form renders for the person filling it in. | string | No | form | one of "form", "wizard", "pdf" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"components": [
{
"key": "firstName",
"label": "First name",
"type": "textfield"
}
],
"display": "form",
"form_type": "form",
"name": "raceRegistration",
"path": "raceregistration",
"title": "Race Registration"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
_id Identifier of the form. | string | — |
title Human-readable name of the form. | string | — |
name Machine name of the form. | string | — |
path API path the form is reachable at within the project. | string | — |
type Whether this is a form or a resource. | string | — |
display How the form renders: form, wizard or pdf. | string | — |
components The component definitions that make up the form. | array | — |
created ISO-8601 timestamp of when the form was created. | string | — |
modified ISO-8601 timestamp of when the form was last changed. | string | — |
{
"_id": "",
"components": [],
"created": "",
"display": "",
"modified": "",
"name": "",
"path": "",
"title": "",
"type": ""
}See Create Form run in a workflow.
In a technical demo we add the Form.io connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.