types/ActionPerformFunction
@prismatic-io/spectral › "types/ActionPerformFunction"
Index
Type aliases
Type aliases
ActionContext
Ƭ ActionContext: object
Defined in packages/spectral/src/types/ActionPerformFunction.ts:26
Context provided to perform method containing helpers and contextual data
Type declaration:
configVars: TConfigVars
crossFlowState: Record‹string, unknown›
customer: CustomerAttributes
executionId: string
executionState: Record‹string, unknown›
flow: FlowAttributes
instance: InstanceAttributes
instanceState: Record‹string, unknown›
integration: IntegrationAttributes
integrationState: Record‹string, unknown›
invokeUrl: string
logger: ActionLogger
startedAt: string
stepId: string
user: UserAttributes
webhookApiKeys: Record‹string, string[]›
webhookUrls: Record‹string, string›
ActionPerformFunction
Ƭ ActionPerformFunction: function
Defined in packages/spectral/src/types/ActionPerformFunction.ts:15
Definition of the function to perform when an Action is invoked.
Type declaration:
▸ (context
: ActionContext‹TConfigVars›, params
: ActionInputParameters‹TInputs›): Promise‹TReturn›
Parameters:
Name | Type |
---|---|
context | ActionContext‹TConfigVars› |
params | ActionInputParameters‹TInputs› |