Skip to content
Proud to collaborate with Microsoft for Startups

github.issues.add_labels ​

Apply GitHub labels to an issue or pull request through the organization's GitHub connection.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID
actorstringNo—Actor initiating the workflow
workflow_run_uuiduuidNo—Parent workflow run UUID
dry_runbooleanNo—Validate and plan without mutating GitHub
github_connection_uuiduuidNo—GitHub installation connection UUID
ownerstringYes—Repository owner login
repostringYes—Repository name
issue_numberintegerYes—Issue or pull request number — GitHub treats PRs as issues for labeling
labelslistYes—Label names to apply
required_prefixeslistNo—Label prefixes that must each match exactly one label

Output Schema ​

FieldTypeRequiredDefaultDescription
statusstringNo——
ownerstringNo——
repostringNo——
issue_numberintegerNo——
labelslistNo——
appliedbooleanNo——
dry_runbooleanNo——
warningslistNo——
prefix_checkjsonNo——
failure_reasonstringNo——
failed_stepstringNo——
failed_layerstringNo——
failed_at_statestringNo——
errorstringNo——
error_typestringNo——
failed_atstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "github.issues.add_labels",
  "initial_data": {
    "organization_uuid": "value",
    "owner": "value",
    "repo": "value",
    "issue_number": 123
  }
}