Skip to main content
objectWorkflow

Fields

id
ID!

Stable identifier for this workflow.

name
String!

Display name of this workflow.

description
String!

Human-readable description of this workflow.

draftDefinition
JSON!

The draft definition associated with this workflow.

draftSchemaVersion
Int!

The draft schema version associated with this workflow.

activeVersionId
ID

Identifier of the related active version. May be null when unavailable or not applicable.

activeVersion

The active version associated with this workflow. May be null when unavailable or not applicable.

enabled
Boolean!

Whether this workflow is enabled.

overlapPolicy

The overlap policy associated with this workflow.

The set of runs the overlap policy is measured against.

maxConcurrentRuns
Int!

The max concurrent runs associated with this workflow.

completionNotificationsEnabled
Boolean!

Whether successful workflow runs create completion notifications.

exclusiveWorktree
Boolean!

Whether each top-level run reserves its worktree for this workflow.

worktreeConcurrency

How runs participate in worktree admission.

blocksGitOperations
Boolean!

Whether command-like jobs launched by this workflow block Git operations.

quickActionKind

The quick action kind associated with this workflow.

quickActionIconKey
String!

The quick action icon key associated with this workflow.

quickActionButtonVariant
String!

The quick action button variant associated with this workflow.

quickActionRepositories

Quick action repositories associated with this workflow.

triggerChoices

Options the published manual trigger offers, for the menu that drops down under a run button. Empty when the matching trigger takes no choice. Pass the resource kind to read the resource trigger instead of the plain manual one.

Arguments
resourceKind
String

The resource kind used to filter or perform the operation.

hasPlainTrigger
Boolean!

Whether the published workflow also has a matching no-choice manual trigger.

Arguments
resourceKind
String

The resource kind used to filter or perform the operation.

archivedAt
String

ISO 8601 timestamp when this workflow was archived. May be null when unavailable or not applicable.

versions

Versions associated with this workflow.

versionCount
Int!

Number of versions.

runCount
Int!

Number of runs.

createdAt
String!

ISO 8601 timestamp when this workflow was created.

updatedAt
String!

ISO 8601 timestamp when this workflow was last updated.