​
Overview

This is a reference of all of the input types that are used in the Connect Portal for collecting user input for pre-OAuth options, post-OAuth options, or User Settings. Implement handlers for each input type to ensure that your UI can prompt your users with the right input types when needed by the integration.
If your app uses React, we recommend starting with our reference implementation, which handles each of the input types below. You can adapt this code for your app or use it as a reference point as you implement.
Some inputs will require loading integration data dynamically using the SDK (for example, loading a list of channels from Slack). See Exposing User Settings for more guidance on loading dynamic data.

​
Input Types

Input TypeSidebarInputType Key(s)Example (click to expand)Used InValue Type
Text input
Set the type attribute of the text input based on the input type.		ValueText | Number | Email | URL | Password
  • PreOptionsStage
  • PostOptionsStage
  • User Settings
string
Textarea input
Note that by default, lines = 1 (in this case, this input should look identical to a text input).		ValueTextArea
  • PreOptionsStage
  • PostOptionsStage
  • User Settings
string
Switch / toggle inputBooleanInput | Switch
  • PreOptionsStage
  • PostOptionsStage
  • User Settings
boolean
Dropdown inputEnum | DynamicEnum | CustomDropdown
  • PreOptionsStage (Enum only)
  • PostOptionsStage (Enum and DynamicEnum only)
  • User Settings
string
Combo dropdown input
Dual dropdown input where items for the secondary dropdown are populated based on the input of the primary dropdown.		ComboInput
  • PostOptionsStage
  • User Settings
ComboDropdownValue
Field mapping input
Input to map fields between an Object Type in the connected integration and an Object Type in your application.		FieldMapper
  • User Settings
FieldMappingValue
Default value mapping input
Input to map “default values” for each field of a particular object when it is created by your integration.

Note: This is currently only supported for the Jira: Issue Field Values input.		DynamicComboInput
  • User Settings
DefaultValueMapping

​
Compound Value Types

Most input types are saved with updateIntegrationUserSettings or updateWorkflowUserSettings as string or boolean values, but more complex inputs have an object value that must be used to save the state of the input. Below is a reference for those compound value types.

​
ComboDropdownValue

A combo dropdown input exposes a dual dropdown: the first input is the mainInput, and the second input is the dependentInput. Both values are saved as strings.
Example
{
  "mainInput": "JIRATEST",
  "dependentInput": "10005"
}
​
mainInput
string
required
The first input in the combo dropdown, for example: the Project input in a Project / Issue Type combo dropdown.
​
dependentInput
string
required
The second input in the combo dropdown, for example: the Issue Type input in a Project / Issue Type combo dropdown.

​
FieldMappingValue

A field mapping input is a compound input which has an Object Type selection (which can be a combo dropdown input) and a list of fields mapped by a user between an Integration Object and an Application Object.
Example
{
  "objectType": "JIRATEST",
  "dependentInput": "10005",
  "mappingType": "STATIC",
  "fieldMappings": {
    "[Application Field Key]": "[Integration Field Key]"
  }
}
​
objectType
string
required
The Integration Object Type that the user selects.
​
dependentInput
string
If the Object Type selection is a combo dropdown input (you can determine this by checking for dependentInputSource on the Field Mapping input options returned by getDataSourceOptions), this will be the value of the dependent input selected by the user. Otherwise, this key can be omitted.
​
mappingType
const
required
Set to "STATIC".
​
fieldMappings
object
required
An object where the keys are field keys from the Application Object and the values are field keys from the Integration Object. A key/value pair represents a mapping between a field in the Application Object and a field in the Integration Object.

​
DefaultValueMappingValue

A default value mapping input is a compound input which has an Object Type selection (which can be a combo dropdown input) and a list of default values for specific fields of the object.
Example
{
  "mainInput": "JIRATEST",
  "dependentInput": "10005",
  "variableInput": {
    "[Integration Field Key]": "[Default Value]"
  }
}
​
mainInput
string
required
The Integration Object Type that the user selects to map default values for.
​
dependentInput
string
If the Object Type selection is a combo dropdown input (you can determine this by checking for dependentInputSource on the Default Value Mapping input options returned by getDataSourceOptions), this will be the value of the dependent input selected by the user. Otherwise, this key can be omitted.
​
variableInput
object
required
An object where the keys are field keys from the Integration Object and the values are default values for those fields, as provided by the user.