setParams

Sets values to the event parameters.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Create a setParams action with assigned static value

Goal: Create a parameter named "birthdate" and assing it a static value.

Key has to be assigned within the params object of the action.

{
  "type": "setParams",
  "params": {
    "birthday": {
      "value": "29.04.1999"
    }
  }
}

Result:

The parameter "birthday" has been set with the value "29.04.1999"

Example 2: Create a setParams action with assigned dynamic value

Goal: Create a parameter named "startDate" and assing it a named form value.

Key has to be assigned within the params object of the action.

{
  "type": "setParams",
  "params": {
    "startDate": {
      "context": "namedForm",
      "field": "timeFrame:pickedStartDate"
    }
  }
}

Result:

The parameter "startDate" has been set with the value of the named form "timeFrame" of the field "pickedStartDate"