Skip to main content

Action Object

Represents an action that is available on a Component.

Return fields#

id (ID!)#

The ID of the object.

component (Component)#

The Component to which this Action is associated.

key (String!)#

A string that uniquely identifies this Action within the context of the Component.

label (String!)#

The name of the Action.

description (String!)#

Additional notes about the Action.

directions (String)#

Notes which may provide insight on the intended use of the Action.

important (Boolean!)#

Specifies whether the Action is important and/or commonly used.

terminateExecution (Boolean!)#

Specifies whether the Action will terminate Instance execution.

allowsBranching (Boolean!)#

Specifies whether the Action will allow Conditional Branching.

isTrigger (Boolean!)#

Specifies whether the Action is an Integration trigger.

staticBranchNames ([String!])#

The static branch names associated with an Action.

dynamicBranchInput (String!)#

A string that associates an Input with Dynamic Branching.

examplePayload (SafeJSONString)#

An example of the returned payload of an Action.

inputs (InputFieldConnection!)#

Returns a Relay Connection to a collection of InputField objects.

allowUpdate (Boolean!)#

Specifies whether the signed-in User can update the Action.

allowRemove (Boolean!)#

Specifies whether the signed-in User can remove the Action.