TriggerBranchingResult
@prismatic-io/spectral › "types/TriggerResult" › TriggerBranchingResult
Represents the result of a Trigger action that uses branching.
#
Hierarchy↳ TriggerBranchingResult
#
Index#
Properties#
Properties#
branch• branch: string
Defined in packages/spectral/src/types/TriggerResult.ts:25
Name of the Branch to take.
Optional
crossFlowState#
• crossFlowState? : Record‹string, unknown›
Inherited from TriggerBaseResult.crossFlowState
Defined in packages/spectral/src/types/TriggerResult.ts:13
An optional object, the keys and values of which will be persisted in the crossFlowState and available in any flow for subsequent actions and executions
Optional
error#
• error? : Record‹string, unknown›
Inherited from TriggerBaseResult.error
Defined in packages/spectral/src/types/TriggerResult.ts:19
A field populated by the Prismatic platform which may refer to an object that contains data about any error that resulted in failure.
Optional
executionState#
• executionState? : Record‹string, unknown›
Inherited from TriggerBaseResult.executionState
Defined in packages/spectral/src/types/TriggerResult.ts:15
An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution
Optional
failed#
• failed? : undefined | false | true
Inherited from TriggerBaseResult.failed
Defined in packages/spectral/src/types/TriggerResult.ts:17
A field populated by the Prismatic platform which indicates whether the trigger failed with an error during execution.
Optional
instanceState#
• instanceState? : Record‹string, unknown›
Inherited from TriggerBaseResult.instanceState
Defined in packages/spectral/src/types/TriggerResult.ts:11
An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions
#
payload• payload: TriggerPayload
Inherited from TriggerBaseResult.payload
Defined in packages/spectral/src/types/TriggerResult.ts:7
The payload in the request that invoked the Integration, which is returned as a result for later use.
Optional
response#
• response? : HttpResponse
Inherited from TriggerBaseResult.response
Defined in packages/spectral/src/types/TriggerResult.ts:9
Optional HTTP response to the request that invoked the integration.