Property description

The colors asset defines colors used for applications or workflow states.

Minimal JSON

{
  "key": "",
  "name": "",
  "colorHex": ""
}
{
  "key": "color_white",
  "name": "White",
  "colorHex": "#FFFFFF"
}

Nested properties

PropertyDescriptionValuesMandatory
keyUnique key of the asset. Used for referencing in the same package or other packages using packageKey#assetKey.stringYes
nameName of the asset, used as the default EN translation.stringYes
colorHexColor hex code of the asset. We recommend using predefined colors from Settings inline-svg-1 > Configuration > Colors.stringYes
colorHoverHexHex code for hover state of the asset. Supported only when used for workflow.stringNo
descriptionDescription of the property, displayed as a tooltip.stringNo
stateCurrent status of the asset. Supported options are: active (asset is active and visible in the environment), inactive (asset is inactive and hidden, serves as a soft delete), hidden (asset is active but hidden in the environment).stringNo
translationsArray of translation keys and their definitions that determine how the text is displayed in the UI for the specific asset. For more information, see Translations.arrayNo