Skip to main content

ActionContext

@prismatic-io/spectral"types/ActionPerformFunction"ActionContext

Context provided to perform method containing helpers and contextual data

Hierarchy#

  • ActionContext

Index#

Properties#

Properties#

crossFlowState#

crossFlowState: Record‹string, unknown›

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

An key/value store what is shared between flows on an Instance that may be used to store small amounts of data that is persisted between Instance executions


customer#

customer: object

Defined in packages/spectral/src/types/ActionPerformFunction.ts:39

An object containing the ID, External ID and name of the customer the instance is deployed to

Type declaration:#

  • externalId: string | null

  • id: string | null

  • name: string | null


executionId#

executionId: string

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

A unique id that corresponds to the specific execution of the Integration


executionState#

executionState: Record‹string, unknown›

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

A key/value store that may be used to store small amounts of data for use later during the execution


instance#

instance: object

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

An object containing the ID ad name of the currently running instance

Type declaration:#

  • id: string | null

  • name: string | null


instanceState#

instanceState: Record‹string, unknown›

Defined in packages/spectral/src/types/ActionPerformFunction.ts:23

A a flow-specific key/value store that may be used to store small amounts of data that is persisted between Instance executions


invokeUrl#

invokeUrl: string

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

The URL used to invoke the current execution


logger#

logger: ActionLogger

Defined in packages/spectral/src/types/ActionPerformFunction.ts:21

Logger for permanent logging; console calls are also captured


stepId#

stepId: string

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

A unique id that corresponds to the step on the Integration


webhookApiKeys#

webhookApiKeys: Record‹string, string[]›

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

An object containing webhook API keys for all flows of the currently running instance


webhookUrls#

webhookUrls: Record‹string, string›

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

An object containing webhook URLs for all flows of the currently running instance