InputField

Definition of a single input field in an app's input schema. Each field maps to a column in the underlying workflow's input action.

Properties

referencestring

Snake_case identifier for this input field (derived from `name`) — use it as the key in `input_data` when running the app

namestring

Human-readable field name displayed in the app UI

descriptionstring

Help text describing what value to provide for this field

typestring

Field type: text, number, email, url, etc.

requiredboolean

Whether this field must be provided when running the app

defaultValue

Default value used when the field is not provided

Example

InputField example

{
  "reference": "linkedin_url",
  "name": "LinkedIn URL",
  "description": "Full LinkedIn company profile URL",
  "type": "text",
  "required": true,
  "defaultValue": null
}