Skip to main content

RequiredConfigVariable Object

Represents a Required Config Variable (with optional default value) associated with an Integration.

Return fields#

id (ID!)#

The ID of the object.

integration (Integration!)#
key (String!)#

The Key for the Required Config Variable. Referred to as 'Name' in the UI.

defaultValue (String)#

The default value for the Required Config Variable if none is specified on the Instance.

header (String)#

The header text that will appear in the UI above the Required Config Variable fields.

hasDivider (Boolean!)#

Specifies whether there is a divider in the UI after the Required Config Variable fields.

dataType (RequiredConfigVariableDataType!)#

The intended datatype of the Required Config Var, used to choose an appropriate UI.

pickList ([String!])#

The valid choices when the Required Config Var uses the 'picklist' dataType.

scheduleType (RequiredConfigVariableScheduleType)#

The schedule type to show in the UI when the Required Config Var uses the 'schedule' dataType.

timeZone (String)#

An optional timezone property for when the Required Config Var uses the 'schedule' dataType.

codeLanguage (RequiredConfigVariableCodeLanguage)#

The language to use in the code editor UI when the Required Config Var uses the 'code' dataType.

description (String)#

Additional notes about the Required Config Var.

sortOrder (Int)#

The UI location in which this Required Config Var will appear relative to the other Required Config Vars for the Integration.

orgOnly (Boolean)#

Specifies whether the Required Config Variable is only viewable by Organization Users.

credentialTypes (RequiredConfigVariableCredentialTypeConnection!)#

The Required Config Var for which the Authorization Method is a valid type of Credential.

allowUpdate (Boolean!)#

Specifies whether the signed-in User can update the RequiredConfigVariable.

allowRemove (Boolean!)#

Specifies whether the signed-in User can remove the RequiredConfigVariable.