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#

T: Inputs

AllowsBranching: boolean

Result: TriggerResult‹AllowsBranching›


  • TriggerDefinition




Optional allowsBranching#

allowsBranching? : AllowsBranching

Defined in types/TriggerDefinition.ts:39

Determines whether this Trigger allows Conditional Branching.

Optional authorization#

authorization? : AuthorizationDefinition

Defined in types/TriggerDefinition.ts:35

Specifies Authorization settings, if applicable


display: ActionDisplayDefinition

Defined in types/TriggerDefinition.ts:25

Defines how the Trigger is displayed in the Prismatic interface.

Optional dynamicBranchInput#

dynamicBranchInput? : undefined | string

Defined in types/TriggerDefinition.ts:43

The Input associated with Dynamic Branching.

Optional examplePayload#

examplePayload? : Result

Defined in types/TriggerDefinition.ts:45

An example of the payload outputted by this Trigger.


inputs: T

Defined in types/TriggerDefinition.ts:29

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

Optional isCommonTrigger#

isCommonTrigger? : undefined | false | true

Defined in types/TriggerDefinition.ts:47

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


perform: TriggerPerformFunction‹T, AllowsBranching, Result›

Defined in types/TriggerDefinition.ts:27

Function to perform when this Trigger is invoked.


scheduleSupport: TriggerOptionChoice

Defined in types/TriggerDefinition.ts:31

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

Optional staticBranchNames#

staticBranchNames? : string[]

Defined in types/TriggerDefinition.ts:41

Static Branch names associated with this Trigger.


synchronousResponseSupport: TriggerOptionChoice

Defined in types/TriggerDefinition.ts:33

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

Optional terminateExecution#

terminateExecution? : undefined | false | true

Defined in types/TriggerDefinition.ts:37

Optional attribute that specifies whether this Trigger will terminate execution.