Skip to main content



TriggerDefinition is the type of the object that is passed in to trigger function to define a component trigger.

Type parameters#

TInputs: Inputs

TAllowsBranching: boolean

TResult: TriggerResult‹TAllowsBranching›


  • TriggerDefinition




Optional allowsBranching#

allowsBranching? : TAllowsBranching

Defined in packages/spectral/src/types/TriggerDefinition.ts:38

Determines whether this Trigger allows Conditional Branching.

Optional breakLoop#

breakLoop? : undefined | false | true

Defined in packages/spectral/src/types/TriggerDefinition.ts:36

Specifies whether an Action will break out of a loop.


display: ActionDisplayDefinition

Defined in packages/spectral/src/types/TriggerDefinition.ts:24

Defines how the Trigger is displayed in the Prismatic interface.

Optional dynamicBranchInput#

dynamicBranchInput? : undefined | string

Defined in packages/spectral/src/types/TriggerDefinition.ts:42

The Input associated with Dynamic Branching.

Optional examplePayload#

examplePayload? : Awaited‹ReturnType‹this["perform"]››

Defined in packages/spectral/src/types/TriggerDefinition.ts:44

An example of the payload outputted by this Trigger.


inputs: TInputs

Defined in packages/spectral/src/types/TriggerDefinition.ts:28

InputFields to present in the Prismatic interface for configuration of this Trigger.

Optional isCommonTrigger#

isCommonTrigger? : undefined | false | true

Defined in packages/spectral/src/types/TriggerDefinition.ts:46

Specifies if this Trigger appears in the list of 'common' Triggers. Only configurable by Prismatic. @default false


perform: TriggerPerformFunction‹TInputs, TAllowsBranching, TResult›

Defined in packages/spectral/src/types/TriggerDefinition.ts:26

Function to perform when this Trigger is invoked.


scheduleSupport: TriggerOptionChoice

Defined in packages/spectral/src/types/TriggerDefinition.ts:30

Specifies whether this Trigger supports executing the Integration on a recurring schedule.

Optional staticBranchNames#

staticBranchNames? : string[]

Defined in packages/spectral/src/types/TriggerDefinition.ts:40

Static Branch names associated with this Trigger.


synchronousResponseSupport: TriggerOptionChoice

Defined in packages/spectral/src/types/TriggerDefinition.ts:32

Specifies whether this Trigger supports synchronous responses to an Integration webhook request.

Optional terminateExecution#

terminateExecution? : undefined | false | true

Defined in packages/spectral/src/types/TriggerDefinition.ts:34

Optional attribute that specifies whether this Trigger will terminate execution.