Skip to main content

TriggerDefinition

@prismatic-io/spectral"types/TriggerDefinition"TriggerDefinition

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›

Hierarchy

  • TriggerDefinition

Index

Properties

Properties

Optional allowsBranching

allowsBranching? : TAllowsBranching

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

Determines whether this Trigger allows Conditional Branching.


Optional breakLoop

breakLoop? : undefined | false | true

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

Specifies whether an Action will break out of a loop.


display

display: ActionDisplayDefinition

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

Defines how the Trigger is displayed in the Prismatic interface.


Optional dynamicBranchInput

dynamicBranchInput? : undefined | string

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

The Input associated with Dynamic Branching.


Optional examplePayload

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

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

An example of the payload outputted by this Trigger.


inputs

inputs: TInputs

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

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:51

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


Optional onInstanceDelete

onInstanceDelete? : TriggerEventFunction‹TInputs›

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

Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deleted.


Optional onInstanceDeploy

onInstanceDeploy? : TriggerEventFunction‹TInputs›

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

Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deployed.


perform

perform: TriggerPerformFunction‹TInputs, TAllowsBranching, TResult›

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

Function to perform when this Trigger is invoked.


scheduleSupport

scheduleSupport: TriggerOptionChoice

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

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


Optional staticBranchNames

staticBranchNames? : string[]

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

Static Branch names associated with this Trigger.


synchronousResponseSupport

synchronousResponseSupport: TriggerOptionChoice

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

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:39

Optional attribute that specifies whether this Trigger will terminate execution.