github.issues.add_labels ​
Apply GitHub labels to an issue or pull request through the organization's GitHub connection.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Organization UUID |
actor | string | No | — | Actor initiating the workflow |
workflow_run_uuid | uuid | No | — | Parent workflow run UUID |
dry_run | boolean | No | — | Validate and plan without mutating GitHub |
github_connection_uuid | uuid | No | — | GitHub installation connection UUID |
owner | string | Yes | — | Repository owner login |
repo | string | Yes | — | Repository name |
issue_number | integer | Yes | — | Issue or pull request number — GitHub treats PRs as issues for labeling |
labels | list | Yes | — | Label names to apply |
required_prefixes | list | No | — | Label prefixes that must each match exactly one label |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | — |
owner | string | No | — | — |
repo | string | No | — | — |
issue_number | integer | No | — | — |
labels | list | No | — | — |
applied | boolean | No | — | — |
dry_run | boolean | No | — | — |
warnings | list | No | — | — |
prefix_check | json | No | — | — |
failure_reason | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
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
}
}