Last updated Sep 15, 2025

Single Condition

Single Conditions are either provided by the host application. See the complete documentation of Conditions for more information. To invert a condition, add the attribute invert="true" to the condition element. This is useful where you want to show the section if a certain condition is not satisfied. A flag indicating whether to invert the boolean result of the condition.

Example

1
2
{
  "condition": "user_is_logged_in",
  "invert": false
}
1
2
{
  "params": {
    "someOtherProperty": "someValue",
    "myCustomProperty": "myValue"
  }
}

Properties

condition

Typestring
Max length100
RequiredYes
DescriptionA string indicating the name of the condition

invert

Typeboolean
DescriptionA flag indicating whether to invert the boolean result of the condition.

params

TypeObject
DescriptionThis object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.

Example:

1
2
{
"params": {
"someOtherProperty": "someValue",
"myCustomProperty": "myValue"
}
}

Rate this page: