Templates

States

Defining periods of time in Stubber

See the concepts section on states and actions for more info.
See the naming conventions for more info on naming states.

Parameters

name

required

string

The name of the state.
Set when creating or renaming the state. The name has to be formatted in kebab-case. This is done automatically when creating or renaming a state in Stubber Editor, with spaces replaced by hyphens on the fly.
See the naming conventions for more info on naming states.

actions

array

An array of action names that the state has access to.

Set by linking a state to an action.

structure

object

This is set by the platform and should not need to be modified.

Contains meta information about the state's position and whether it is new, renamed or deleted.

structure.meta.is_done is a boolean that indicates whether the state is the final state in the template.