IntegrationRuntimeConfigField

A config field as declared in the integration's manifest.

type IntegrationRuntimeConfigField {
  autogen: Boolean!
  defaultValue: JSON
  example: JSON
  format: IntegrationRuntimeConfigFieldFormat
  help: String
  integer: Boolean!
  items: IntegrationRuntimeConfigListItem
  key: String!
  label: String!
  max: Float
  maxItems: Int
  maxLength: Int
  min: Float
  minLength: Int
  nullable: Boolean!
  pattern: String
  required: Boolean!
  type: IntegrationRuntimeConfigFieldType!
  unit: IntegrationRuntimeConfigFieldUnit
  values: [String!]
}

Fields

IntegrationRuntimeConfigField.autogen ● Boolean! non-null scalar common

Whether the platform generates the value, so it can't be edited.

IntegrationRuntimeConfigField.defaultValue ● JSON scalar common

The value the form starts with: a string, number or boolean, or a list of strings for a LIST field.

IntegrationRuntimeConfigField.example ● JSON scalar common

An example value for the input placeholder, with the same shape as defaultValue.

IntegrationRuntimeConfigField.format ● IntegrationRuntimeConfigFieldFormat enum common

A common format the string value must have.

IntegrationRuntimeConfigField.help ● String scalar common

Help text shown with the field.

IntegrationRuntimeConfigField.integer ● Boolean! non-null scalar common

Whether a NUMBER field only accepts whole numbers.

IntegrationRuntimeConfigField.items ● IntegrationRuntimeConfigListItem object common

What each entry of a LIST field must be.

IntegrationRuntimeConfigField.key ● String! non-null scalar common

The key the value is stored under in the config.

IntegrationRuntimeConfigField.label ● String! non-null scalar common

The field label.

IntegrationRuntimeConfigField.max ● Float scalar common

The largest value a NUMBER field accepts.

IntegrationRuntimeConfigField.maxItems ● Int scalar common

The most entries a LIST field accepts.

IntegrationRuntimeConfigField.maxLength ● Int scalar common

The maximum number of characters of a string value.

IntegrationRuntimeConfigField.min ● Float scalar common

The smallest value a NUMBER field accepts.

IntegrationRuntimeConfigField.minLength ● Int scalar common

The minimum number of characters of a string value.

IntegrationRuntimeConfigField.nullable ● Boolean! non-null scalar common

Whether saving null clears the value, so the integration falls back to its own default.

IntegrationRuntimeConfigField.pattern ● String scalar common

A regular expression (JavaScript syntax) the whole string value must match.

IntegrationRuntimeConfigField.required ● Boolean! non-null scalar common

Whether the field must be filled before the integration can be enabled.

IntegrationRuntimeConfigField.type ● IntegrationRuntimeConfigFieldType! non-null enum common

The input type.

IntegrationRuntimeConfigField.unit ● IntegrationRuntimeConfigFieldUnit enum common

The unit a NUMBER field is in.

IntegrationRuntimeConfigField.values ● [String!] list scalar common

The allowed values of an ENUM field.

Member Of

IntegrationRuntimeConfig object