Templates

Actions

Actions are the options available to a user or an AI to perform in each state.

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

Parameters

name

The name of the action.
Set when creating or renaming the action.

details.description

Should be used to describe what happens when the action is performed and/or under what circumstances it should be performed.

This is visible to users on the Stubs platform, as well as to AI assistants if the action is AI Enabled.

to_state

A set of states that the action can transition to.

Set by linking an action to a state.

fields

See fields documentation for more information.

tasks

See tasks documentation for more information.

notifications

See notifications documentation for more information.

metrics

See metrics documentation for more information.

structure

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

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

action_meta

See the action meta documentation for more information.