Design the Connection Screen

REST connector connection

Expose only the connection inputs an administrator needs, then reuse their values throughout the connector.

Add connection itemsDirect link to Add connection items

Define controls in connection.items to display them on the REST system's Connection tab. Supported item types include text, textbox, textarea, checkbox, date, radio, combo, checkgroup, grid, button, icon, wizard, and schema upload.

"connection": {
  "items": [
    { "name": "tenant", "type": "textbox", "label": "Tenant", "order": 10 },
    { "name": "page_size", "type": "textbox", "label": "Page size", "value": "100", "order": 20 }
  ]
}

Reference a value anywhere in the connector with {name}, for example "baseUrl": "https://{tenant}.example.com/api".

For credential fields and token exchanges, follow REST connector authentication. Use password: true on custom textbox items containing secrets, and reference connection values in authentication options and headers.

Design safelyDirect link to Design safely

Keep name values stable; changing one breaks all {name} references.
Use administrator-friendly labels and a deliberate order.
Use hidden and disabled for dependent options.
Buttons can trigger JavaScript or service actions on click, update, or initialize; never expose secrets in labels or messages.

Set control defaults and help textDirect link to Set control defaults and help text

Item option	Purpose
`value`	Default input value. Its type depends on the control: a textbox takes a string, a checkbox a boolean, and a checkgroup an array of selected names. A text display uses `text`, not `value`.
`required`	Mark an input as required.
`tooltip`	Add explanatory help text.
`label_indent`	Indent the item label when true.
`text`	Display text or a button label, depending on the control.
`hidden` / `disabled`	Name the connection value controlling visibility or availability. Prefix the name with `!` to negate it; these properties are strings, not booleans.

The Google Workspace, Skyward Qmlativ, and Google Sheets connectors show dependent controls, required fields, and tooltips. Consult the selected control's schema branch for its supported properties.