return

The return action breaks all following actions in the same action block.

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: Return after a specific condition is fullfilled

Show ExampleHide Example

The return action is combined with the if action. If the condition right equals left returns true, then the return action is executed and all actions after this block will not be called.

{
  "type": "if",
  "params": {
    "condition": {
      "mode": "equal",
      "right": "{{data}}",
      "left": "2"
    },
    "then": [
      {
        "type": "return"
      }
    ]
  }
}