The input function validates and returns an InputFieldDefinition object. Inputs define the configuration fields presented to integration builders in the Prismatic UI. The resolved input values are passed to the perform function via the params argument.
Function signature function input < T extends InputFieldDefinition >( definition : T ) : T
Common fields All input types share the following base fields:
label
string | { key: string; value: string }
required
The field label shown in the UI. Accepts a plain string or a { key, value } object for localization.
The input type. See type-specific documentation below.
When true, the integration builder must provide a value for this input.
Placeholder text shown in the input field before a value is entered.
Help text displayed below the input field to guide the integration builder.
An example of a valid value for this input.
Default value pre-populated in the input field.
collection
'valuelist' | 'keyvaluelist'
When set, this input accepts multiple values instead of a single value.
"valuelist" — a list of values of the input’s base type"keyvaluelist" — a list of key/value pairs where each value is the input’s base type A list of predefined choices rendered as a dropdown. Available for string, data, text, password, boolean, date, and timestamp types. Show InputFieldChoice fields
Display label for this choice.
The value submitted when this choice is selected.
clean
(value: unknown) => TResult
A function that transforms the raw input value before it is passed to perform. Useful for parsing, coercing types, or stripping whitespace. The return type of clean determines the TypeScript type seen in params.
Key of a data source defined in the same component that can be used to dynamically populate the allowed values for this input.
string
text
data
password
boolean
code
connection
conditional
date
timestamp
objectSelection
objectFieldMap
dynamicObjectSelection
dynamicFieldSelection
jsonForm
A single-line text input. input ({ label: "API Endpoint" , type: "string" , required: true , placeholder: "https://api.example.com" , comments: "The base URL for the API" , example: "https://api.acme.com" , })
A multi-line text area input. input ({ label: "Message Body" , type: "text" , required: false , placeholder: "Enter message content..." , })
A binary data input. Accepts file uploads or binary content. input ({ label: "File Content" , type: "data" , required: true , comments: "The binary content of the file to upload" , })
A masked text input for sensitive values. input ({ label: "API Secret" , type: "password" , required: true , placeholder: "Your API secret key" , })
A toggle/checkbox input. input ({ label: "Enable Notifications" , type: "boolean" , default: "false" , comments: "Send email notifications when this action completes" , })
A syntax-highlighted code editor. input ({ label: "Transformation Script" , type: "code" , language: "javascript" , required: false , comments: "JavaScript function to transform the payload" , })
The language field is required for code inputs. Supported values:
"css", "graphql", "handlebars", "hcl", "html", "javascript", "json", "liquid", "markdown", "mysql", "pgsql", "plaintext", "sql", "typescript", "xml", "yaml" An input that accepts a connection config variable. input ({ label: "Connection" , type: "connection" , required: true , })
The resolved value is a Connectionkey, configVarKey, fields, token, and context properties. A conditional logic expression builder. input ({ label: "Filter Condition" , type: "conditional" , collection: "valuelist" , required: false , comments: "Conditions to filter records" , })
The collection field is required for conditional inputs. A date picker (date only, no time). input ({ label: "Start Date" , type: "date" , required: false , placeholder: "YYYY-MM-DD" , })
A datetime picker (date and time). input ({ label: "Event Timestamp" , type: "timestamp" , required: false , placeholder: "2026-01-01T00:00:00Z" , })
An object selection widget for choosing objects and fields. input ({ label: "Objects to Sync" , type: "objectSelection" , required: false , dataSource: "listObjects" , })
A field mapping widget. input ({ label: "Field Mapping" , type: "objectFieldMap" , required: false , dataSource: "getFieldOptions" , })
A dynamic object selection input backed by a data source. input ({ label: "Target Object" , type: "dynamicObjectSelection" , required: true , })
A dynamic field selection input backed by a data source. input ({ label: "Target Field" , type: "dynamicFieldSelection" , required: true , })
A JSON Forms-powered dynamic form. input ({ label: "Configuration" , type: "jsonForm" , required: false , dataSource: "configForm" , })
Collections When collection is set, the input accepts multiple values. The default type and resolved params type change accordingly:
Collection default typeResolved params type (none) TT"valuelist"T[]T[]"keyvaluelist"KeyValuePair<T>[]KeyValuePair<T>[]
// A list of string values input ({ label: "Allowed Domains" , type: "string" , collection: "valuelist" , default: [ "example.com" , "acme.com" ], }) // A list of key/value pairs input ({ label: "HTTP Headers" , type: "string" , collection: "keyvaluelist" , default: [{ key: "Content-Type" , value: "application/json" }], })
clean functionThe clean function coerces or validates the raw input value before it reaches the perform function:
import { input , util } from "@prismatic-io/spectral" ; const maxRetries = input ({ label: "Max Retries" , type: "string" , default: "3" , clean : ( value ) => util . types . toInt ( value , 3 ), }); // In perform, params.maxRetries is typed as number
Connection objectWhen a connection input is resolved, params.myConnection contains:
Programmatic key of the connection type.
Name of the config variable hosting this connection.
fields
{ [key: string]: unknown }
Input field values supplied to this connection (e.g., fields.apiKey).
OAuth 2.0 token data (e.g., access_token, refresh_token, expires_in). Present only for OAuth 2.0 connections.
OAuth 2.0 token metadata (e.g., expiration time). Present only for OAuth 2.0 connections.
