Update issues webhook event activity types by broccolinisoup · Pull Request #44574 · github/docs
Conversation
Docs https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows is missing the new 'field_added' and 'field_removed' issue types on the issues workflow trigger. This PR adds this.
Added new activity types 'field_added' and 'field_removed' to the issues webhook event.
Why:
Closes:
What's being changed (if available, include any code snippets, screenshots, or gifs):
Check off the following:
- A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
- The changes in this PR meet the docs fundamentals that are required for all content.
- All CI checks are passing and the changes look good in the review environment.
Copilot AI review requested due to automatic review settings
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the GitHub Actions documentation for workflow triggers to reflect additional issues webhook activity types.
Changes:
- Adds
field_addedandfield_removedto theissuesevent activity type list in the trigger reference table.
Show a summary per file
| File | Description |
|---|---|
| content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md | Expands the documented issues activity types to include field_added/field_removed. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 1
| | Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` | | ||
| | --------------------- | -------------- | ------------ | -------------| | ||
| | [`issues`](/webhooks-and-events/webhooks/webhook-events-and-payloads#issues) | - `opened`<br/>- `edited`<br/>- `deleted`<br/>- `transferred`<br/>- `pinned`<br/>- `unpinned`<br/>- `closed`<br/>- `reopened`<br/>- `assigned`<br/>- `unassigned`<br/>- `labeled`<br/>- `unlabeled`<br/>- `locked`<br/>- `unlocked`<br/>- `milestoned`<br/> - `demilestoned`<br/> - `typed`<br/> - `untyped` | Last commit on default branch | Default branch | | ||
| | [`issues`](/webhooks-and-events/webhooks/webhook-events-and-payloads#issues) | - `opened`<br/>- `edited`<br/>- `deleted`<br/>- `transferred`<br/>- `pinned`<br/>- `unpinned`<br/>- `closed`<br/>- `reopened`<br/>- `assigned`<br/>- `unassigned`<br/>- `labeled`<br/>- `unlabeled`<br/>- `locked`<br/>- `unlocked`<br/>- `milestoned`<br/> - `demilestoned`<br/> - `field_added`<br/> - `field_removed`<br/> - `typed`<br/> - `untyped` | Last commit on default branch | Default branch | |
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like a valid thing to address? Super NIT, though.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah sorry I missed this comment.
| | Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` | | ||
| | --------------------- | -------------- | ------------ | -------------| | ||
| | [`issues`](/webhooks-and-events/webhooks/webhook-events-and-payloads#issues) | - `opened`<br/>- `edited`<br/>- `deleted`<br/>- `transferred`<br/>- `pinned`<br/>- `unpinned`<br/>- `closed`<br/>- `reopened`<br/>- `assigned`<br/>- `unassigned`<br/>- `labeled`<br/>- `unlabeled`<br/>- `locked`<br/>- `unlocked`<br/>- `milestoned`<br/> - `demilestoned`<br/> - `typed`<br/> - `untyped` | Last commit on default branch | Default branch | | ||
| | [`issues`](/webhooks-and-events/webhooks/webhook-events-and-payloads#issues) | - `opened`<br/>- `edited`<br/>- `deleted`<br/>- `transferred`<br/>- `pinned`<br/>- `unpinned`<br/>- `closed`<br/>- `reopened`<br/>- `assigned`<br/>- `unassigned`<br/>- `labeled`<br/>- `unlabeled`<br/>- `locked`<br/>- `unlocked`<br/>- `milestoned`<br/> - `demilestoned`<br/> - `field_added`<br/> - `field_removed`<br/> - `typed`<br/> - `untyped` | Last commit on default branch | Default branch | |
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like a valid thing to address? Super NIT, though.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
Normalize '<br/> - ' to '<br/>- ' for demilestoned, field_added, field_removed, typed, and untyped to match the rest of the list. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>