Class WorkflowDataAttributes

The definition of WorkflowDataAttributes object.

Hierarchy

  • WorkflowDataAttributes

Constructors

constructor

Properties

additionalProperties? createdAt? description? name published? runAs? runAsUserMode? sensitivePrivileges? spec tags? updatedAt? webhookSecret?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional createdAt

createdAt?: Date

When the workflow was created.

Optional description

description?: string

Description of the workflow.

name

name: string

Name of the workflow.

Optional published

published?: boolean

Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.

Optional runAs

runAs?: WorkflowRunAs

Identity used to run the workflow.

Optional runAsUserMode

runAsUserMode?: WorkflowRunAsUserMode

The effective type of identity used to run the workflow.

Optional sensitivePrivileges

sensitivePrivileges?: boolean

Whether the workflow requires sensitive privileges to run. Only the workflow owner can update this field. This allows it to run actions that use Execution Policies.

spec

spec: Spec

A complete Workflow Automation definition, including its triggers, steps, and connections.

Optional tags

tags?: string[]

Tags of the workflow.

Optional updatedAt

updatedAt?: Date

When the workflow was last updated.

Optional webhookSecret

webhookSecret?: string

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

Settings

Member Visibility

Theme

Generated using TypeDoc