This page was generated based on Github’s Documentation. See our welcome page for context and details.
Github Event issues
#
Github Action Trigger #
Webhook event payload | Activity types | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
issues | - opened - edited - deleted - transferred - pinned - unpinned - closed - reopened - assigned - unassigned - labeled - unlabeled - locked - unlocked - milestoned - demilestoned | Last commit on default branch | Default branch |
Note: More than one activity type triggers this event. For information about each activity type, see “Webhook events and payloads.” By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the types
keyword. For more information, see “Workflow syntax for GitHub Actions.”
Note: This event will only trigger a workflow run if the workflow file is on the default branch.
Runs your workflow when an issue in the workflow’s repository is created or modified. For activity related to comments in an issue, use the issue_comment
event. For more information about issues, see “About issues.” For information about the issue APIs, see “Objects” in the GraphQL API documentation or “REST API endpoints for issues.”
For example, you can run a workflow when an issue has been opened
, edited
, or milestoned
.
on:
issues:
types: [opened, edited, milestoned]
Event Payload #
Activities: assigned
, closed
, deleted
, demilestoned
, edited
, labeled
, locked
, milestoned
, opened
, pinned
, reopened
, transferred
, unassigned
, unlabeled
, unlocked
, unpinned
Common Fields #
These fields are common to every event types available with this trigger.
field | type | required | description |
---|---|---|---|
github.event.enterprise | object | optional | An enterprise on GitHub. Webhook payloads contain the |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.issue | object | required | The issue itself. |
github.event.issue.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.issue.assignee | object or null | optional | |
github.event.issue.assignees | array of object,nulls | required | |
github.event.issue.author_association | COLLABORATOR , CONTRIBUTOR , FIRST_TIMER , FIRST_TIME_CONTRIBUTOR , MANNEQUIN , MEMBER , NONE , OWNER | required | How the author is associated with the repository. |
github.event.issue.body | string or null | required | Contents of the issue |
github.event.issue.closed_at | string or null | required | |
github.event.issue.comments | integer | required | |
github.event.issue.comments_url | string | required | |
github.event.issue.created_at | string | required | |
github.event.issue.draft | boolean | optional | |
github.event.issue.events_url | string | required | |
github.event.issue.html_url | string | required | |
github.event.issue.id | integer | required | |
github.event.issue.labels_url | string | required | |
github.event.issue.milestone | object or null | required | A collection of related issues and pull requests. |
github.event.issue.milestone.closed_at | string or null | required | |
github.event.issue.milestone.closed_issues | integer | required | |
github.event.issue.milestone.created_at | string | required | |
github.event.issue.milestone.creator | object or null | required | |
github.event.issue.milestone.creator.avatar_url | string | optional | |
github.event.issue.milestone.creator.deleted | boolean | optional | |
github.event.issue.milestone.creator.email | string or null | optional | |
github.event.issue.milestone.creator.events_url | string | optional | |
github.event.issue.milestone.creator.followers_url | string | optional | |
github.event.issue.milestone.creator.following_url | string | optional | |
github.event.issue.milestone.creator.gists_url | string | optional | |
github.event.issue.milestone.creator.gravatar_id | string | optional | |
github.event.issue.milestone.creator.html_url | string | optional | |
github.event.issue.milestone.creator.id | integer | required | |
github.event.issue.milestone.creator.login | string | required | |
github.event.issue.milestone.creator.name | string | optional | |
github.event.issue.milestone.creator.node_id | string | optional | |
github.event.issue.milestone.creator.organizations_url | string | optional | |
github.event.issue.milestone.creator.received_events_url | string | optional | |
github.event.issue.milestone.creator.repos_url | string | optional | |
github.event.issue.milestone.creator.site_admin | boolean | optional | |
github.event.issue.milestone.creator.starred_url | string | optional | |
github.event.issue.milestone.creator.subscriptions_url | string | optional | |
github.event.issue.milestone.creator.url | string | optional | |
github.event.issue.milestone.description | string or null | required | |
github.event.issue.milestone.due_on | string or null | required | |
github.event.issue.milestone.html_url | string | required | |
github.event.issue.milestone.id | integer | required | |
github.event.issue.milestone.labels_url | string | required | |
github.event.issue.milestone.node_id | string | required | |
github.event.issue.milestone.number | integer | required | The number of the milestone. |
github.event.issue.milestone.open_issues | integer | required | |
github.event.issue.milestone.state | open , closed | required | The state of the milestone. |
github.event.issue.milestone.title | string | required | The title of the milestone. |
github.event.issue.milestone.updated_at | string | required | |
github.event.issue.milestone.url | string | required | |
github.event.issue.node_id | string | required | |
github.event.issue.number | integer | required | |
github.event.issue.pull_request | object | optional | |
github.event.issue.pull_request.diff_url | string | optional | |
github.event.issue.pull_request.html_url | string | optional | |
github.event.issue.pull_request.merged_at | string or null | optional | |
github.event.issue.pull_request.patch_url | string | optional | |
github.event.issue.pull_request.url | string | optional | |
github.event.issue.reactions | object | required | |
github.event.issue.reactions.+1 | integer | required | |
github.event.issue.reactions.-1 | integer | required | |
github.event.issue.reactions.confused | integer | required | |
github.event.issue.reactions.eyes | integer | required | |
github.event.issue.reactions.heart | integer | required | |
github.event.issue.reactions.hooray | integer | required | |
github.event.issue.reactions.laugh | integer | required | |
github.event.issue.reactions.rocket | integer | required | |
github.event.issue.reactions.total_count | integer | required | |
github.event.issue.reactions.url | string | required | |
github.event.issue.repository_url | string | required | |
github.event.issue.state_reason | string or null | optional | |
github.event.issue.timeline_url | string | optional | |
github.event.issue.title | string | required | Title of the issue |
github.event.issue.updated_at | string | required | |
github.event.issue.url | string | required | URL for the issue |
github.event.issue.user | object or null | required | |
github.event.issue.user.avatar_url | string | optional | |
github.event.issue.user.deleted | boolean | optional | |
github.event.issue.user.email | string or null | optional | |
github.event.issue.user.events_url | string | optional | |
github.event.issue.user.followers_url | string | optional | |
github.event.issue.user.following_url | string | optional | |
github.event.issue.user.gists_url | string | optional | |
github.event.issue.user.gravatar_id | string | optional | |
github.event.issue.user.html_url | string | optional | |
github.event.issue.user.id | integer | required | |
github.event.issue.user.login | string | required | |
github.event.issue.user.name | string | optional | |
github.event.issue.user.node_id | string | optional | |
github.event.issue.user.organizations_url | string | optional | |
github.event.issue.user.received_events_url | string | optional | |
github.event.issue.user.repos_url | string | optional | |
github.event.issue.user.site_admin | boolean | optional | |
github.event.issue.user.starred_url | string | optional | |
github.event.issue.user.subscriptions_url | string | optional | |
github.event.issue.user.url | string | optional | |
github.event.organization | object | optional | A GitHub organization. Webhook payloads contain the |
github.event.repository | object | required | The repository on GitHub where the event occurred. Webhook payloads contain the |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
assigned
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | assigned | required | The action that was performed. |
github.event.assignee | object or null | optional | |
github.event.assignee.avatar_url | string | optional | |
github.event.assignee.deleted | boolean | optional | |
github.event.assignee.email | string or null | optional | |
github.event.assignee.events_url | string | optional | |
github.event.assignee.followers_url | string | optional | |
github.event.assignee.following_url | string | optional | |
github.event.assignee.gists_url | string | optional | |
github.event.assignee.gravatar_id | string | optional | |
github.event.assignee.html_url | string | optional | |
github.event.assignee.id | integer | required | |
github.event.assignee.login | string | required | |
github.event.assignee.name | string | optional | |
github.event.assignee.node_id | string | optional | |
github.event.assignee.organizations_url | string | optional | |
github.event.assignee.received_events_url | string | optional | |
github.event.assignee.repos_url | string | optional | |
github.event.assignee.site_admin | boolean | optional | |
github.event.assignee.starred_url | string | optional | |
github.event.assignee.subscriptions_url | string | optional | |
github.event.assignee.type | Bot , User , Organization | optional | |
github.event.assignee.url | string | optional | |
github.event.issue.assignee.avatar_url | string | optional | |
github.event.issue.assignee.deleted | boolean | optional | |
github.event.issue.assignee.email | string or null | optional | |
github.event.issue.assignee.events_url | string | optional | |
github.event.issue.assignee.followers_url | string | optional | |
github.event.issue.assignee.following_url | string | optional | |
github.event.issue.assignee.gists_url | string | optional | |
github.event.issue.assignee.gravatar_id | string | optional | |
github.event.issue.assignee.html_url | string | optional | |
github.event.issue.assignee.id | integer | required | |
github.event.issue.assignee.login | string | required | |
github.event.issue.assignee.name | string | optional | |
github.event.issue.assignee.node_id | string | optional | |
github.event.issue.assignee.organizations_url | string | optional | |
github.event.issue.assignee.received_events_url | string | optional | |
github.event.issue.assignee.repos_url | string | optional | |
github.event.issue.assignee.site_admin | boolean | optional | |
github.event.issue.assignee.starred_url | string | optional | |
github.event.issue.assignee.subscriptions_url | string | optional | |
github.event.issue.assignee.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.assignee.url | string | optional | |
github.event.issue.labels | array of objects | optional | |
github.event.issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.issue.labels.default | boolean | required | |
github.event.issue.labels.description | string or null | required | |
github.event.issue.labels.id | integer | required | |
github.event.issue.labels.name | string | required | The name of the label. |
github.event.issue.labels.node_id | string | required | |
github.event.issue.labels.url | string | required | URL for the label |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.issue.performed_via_github_app.created_at | string or null | required | |
github.event.issue.performed_via_github_app.description | string or null | required | |
github.event.issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.issue.performed_via_github_app.external_url | string or null | required | |
github.event.issue.performed_via_github_app.html_url | string | required | |
github.event.issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.issue.performed_via_github_app.node_id | string | required | |
github.event.issue.performed_via_github_app.owner | object or null | required | |
github.event.issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.issue.performed_via_github_app.owner.id | integer | required | |
github.event.issue.performed_via_github_app.owner.login | string | required | |
github.event.issue.performed_via_github_app.owner.name | string | optional | |
github.event.issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app.owner.url | string | optional | |
github.event.issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_projects | read , write , admin | optional | |
github.event.issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.issue.performed_via_github_app.updated_at | string or null | required | |
github.event.issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.issue.user.type | Bot , User , Organization , Mannequin | optional |
closed
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | closed | required | The action that was performed. |
github.event.issue.labels | array of object,nulls | optional | |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.performed_via_github_app | object or null | optional | |
github.event.issue.state | closed , open | required | |
github.event.issue.user.type | Bot , User , Organization , Mannequin | optional |
deleted
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | deleted | required | |
github.event.issue.assignee.avatar_url | string | optional | |
github.event.issue.assignee.deleted | boolean | optional | |
github.event.issue.assignee.email | string or null | optional | |
github.event.issue.assignee.events_url | string | optional | |
github.event.issue.assignee.followers_url | string | optional | |
github.event.issue.assignee.following_url | string | optional | |
github.event.issue.assignee.gists_url | string | optional | |
github.event.issue.assignee.gravatar_id | string | optional | |
github.event.issue.assignee.html_url | string | optional | |
github.event.issue.assignee.id | integer | required | |
github.event.issue.assignee.login | string | required | |
github.event.issue.assignee.name | string | optional | |
github.event.issue.assignee.node_id | string | optional | |
github.event.issue.assignee.organizations_url | string | optional | |
github.event.issue.assignee.received_events_url | string | optional | |
github.event.issue.assignee.repos_url | string | optional | |
github.event.issue.assignee.site_admin | boolean | optional | |
github.event.issue.assignee.starred_url | string | optional | |
github.event.issue.assignee.subscriptions_url | string | optional | |
github.event.issue.assignee.type | Bot , User , Organization | optional | |
github.event.issue.assignee.url | string | optional | |
github.event.issue.labels | array of objects | optional | |
github.event.issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.issue.labels.default | boolean | required | |
github.event.issue.labels.description | string or null | required | |
github.event.issue.labels.id | integer | required | |
github.event.issue.labels.name | string | required | The name of the label. |
github.event.issue.labels.node_id | string | required | |
github.event.issue.labels.url | string | required | URL for the label |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.issue.performed_via_github_app.created_at | string or null | required | |
github.event.issue.performed_via_github_app.description | string or null | required | |
github.event.issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.issue.performed_via_github_app.external_url | string or null | required | |
github.event.issue.performed_via_github_app.html_url | string | required | |
github.event.issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.issue.performed_via_github_app.node_id | string | required | |
github.event.issue.performed_via_github_app.owner | object or null | required | |
github.event.issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.issue.performed_via_github_app.owner.id | integer | required | |
github.event.issue.performed_via_github_app.owner.login | string | required | |
github.event.issue.performed_via_github_app.owner.name | string | optional | |
github.event.issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app.owner.url | string | optional | |
github.event.issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.issue.performed_via_github_app.updated_at | string or null | required | |
github.event.issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.issue.user.type | Bot , User , Organization | optional |
demilestoned
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | demilestoned | required | |
github.event.issue.labels | array of object,nulls | optional | |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.performed_via_github_app | object or null | optional | |
github.event.issue.state | string | optional | |
github.event.issue.user.type | Bot , User , Organization , Mannequin | optional | |
github.event.milestone | object | optional | A collection of related issues and pull requests. |
github.event.milestone.closed_at | string or null | required | |
github.event.milestone.closed_issues | integer | required | |
github.event.milestone.created_at | string | required | |
github.event.milestone.creator | object or null | required | |
github.event.milestone.creator.avatar_url | string | optional | |
github.event.milestone.creator.deleted | boolean | optional | |
github.event.milestone.creator.email | string or null | optional | |
github.event.milestone.creator.events_url | string | optional | |
github.event.milestone.creator.followers_url | string | optional | |
github.event.milestone.creator.following_url | string | optional | |
github.event.milestone.creator.gists_url | string | optional | |
github.event.milestone.creator.gravatar_id | string | optional | |
github.event.milestone.creator.html_url | string | optional | |
github.event.milestone.creator.id | integer | required | |
github.event.milestone.creator.login | string | required | |
github.event.milestone.creator.name | string | optional | |
github.event.milestone.creator.node_id | string | optional | |
github.event.milestone.creator.organizations_url | string | optional | |
github.event.milestone.creator.received_events_url | string | optional | |
github.event.milestone.creator.repos_url | string | optional | |
github.event.milestone.creator.site_admin | boolean | optional | |
github.event.milestone.creator.starred_url | string | optional | |
github.event.milestone.creator.subscriptions_url | string | optional | |
github.event.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.milestone.creator.url | string | optional | |
github.event.milestone.description | string or null | required | |
github.event.milestone.due_on | string or null | required | |
github.event.milestone.html_url | string | required | |
github.event.milestone.id | integer | required | |
github.event.milestone.labels_url | string | required | |
github.event.milestone.node_id | string | required | |
github.event.milestone.number | integer | required | The number of the milestone. |
github.event.milestone.open_issues | integer | required | |
github.event.milestone.state | open , closed | required | The state of the milestone. |
github.event.milestone.title | string | required | The title of the milestone. |
github.event.milestone.updated_at | string | required | |
github.event.milestone.url | string | required |
edited
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | edited | required | |
github.event.changes | object | required | The changes to the issue. |
github.event.changes.body | object | optional | |
github.event.changes.body.from | string | required | The previous version of the body. |
github.event.changes.title | object | optional | |
github.event.changes.title.from | string | required | The previous version of the title. |
github.event.issue.assignee.avatar_url | string | optional | |
github.event.issue.assignee.deleted | boolean | optional | |
github.event.issue.assignee.email | string or null | optional | |
github.event.issue.assignee.events_url | string | optional | |
github.event.issue.assignee.followers_url | string | optional | |
github.event.issue.assignee.following_url | string | optional | |
github.event.issue.assignee.gists_url | string | optional | |
github.event.issue.assignee.gravatar_id | string | optional | |
github.event.issue.assignee.html_url | string | optional | |
github.event.issue.assignee.id | integer | required | |
github.event.issue.assignee.login | string | required | |
github.event.issue.assignee.name | string | optional | |
github.event.issue.assignee.node_id | string | optional | |
github.event.issue.assignee.organizations_url | string | optional | |
github.event.issue.assignee.received_events_url | string | optional | |
github.event.issue.assignee.repos_url | string | optional | |
github.event.issue.assignee.site_admin | boolean | optional | |
github.event.issue.assignee.starred_url | string | optional | |
github.event.issue.assignee.subscriptions_url | string | optional | |
github.event.issue.assignee.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.assignee.url | string | optional | |
github.event.issue.labels | array of objects | optional | |
github.event.issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.issue.labels.default | boolean | required | |
github.event.issue.labels.description | string or null | required | |
github.event.issue.labels.id | integer | required | |
github.event.issue.labels.name | string | required | The name of the label. |
github.event.issue.labels.node_id | string | required | |
github.event.issue.labels.url | string | required | URL for the label |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.issue.performed_via_github_app.created_at | string or null | required | |
github.event.issue.performed_via_github_app.description | string or null | required | |
github.event.issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.issue.performed_via_github_app.external_url | string or null | required | |
github.event.issue.performed_via_github_app.html_url | string | required | |
github.event.issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.issue.performed_via_github_app.node_id | string | required | |
github.event.issue.performed_via_github_app.owner | object or null | required | |
github.event.issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.issue.performed_via_github_app.owner.id | integer | required | |
github.event.issue.performed_via_github_app.owner.login | string | required | |
github.event.issue.performed_via_github_app.owner.name | string | optional | |
github.event.issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app.owner.url | string | optional | |
github.event.issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_projects | read , write , admin | optional | |
github.event.issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.issue.performed_via_github_app.updated_at | string or null | required | |
github.event.issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.issue.user.type | Bot , User , Organization , Mannequin | optional | |
github.event.label | object | optional | |
github.event.label.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.label.default | boolean | required | |
github.event.label.description | string or null | required | |
github.event.label.id | integer | required | |
github.event.label.name | string | required | The name of the label. |
github.event.label.node_id | string | required | |
github.event.label.url | string | required | URL for the label |
labeled
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | labeled | required | |
github.event.issue.assignee.avatar_url | string | optional | |
github.event.issue.assignee.deleted | boolean | optional | |
github.event.issue.assignee.email | string or null | optional | |
github.event.issue.assignee.events_url | string | optional | |
github.event.issue.assignee.followers_url | string | optional | |
github.event.issue.assignee.following_url | string | optional | |
github.event.issue.assignee.gists_url | string | optional | |
github.event.issue.assignee.gravatar_id | string | optional | |
github.event.issue.assignee.html_url | string | optional | |
github.event.issue.assignee.id | integer | required | |
github.event.issue.assignee.login | string | required | |
github.event.issue.assignee.name | string | optional | |
github.event.issue.assignee.node_id | string | optional | |
github.event.issue.assignee.organizations_url | string | optional | |
github.event.issue.assignee.received_events_url | string | optional | |
github.event.issue.assignee.repos_url | string | optional | |
github.event.issue.assignee.site_admin | boolean | optional | |
github.event.issue.assignee.starred_url | string | optional | |
github.event.issue.assignee.subscriptions_url | string | optional | |
github.event.issue.assignee.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.assignee.url | string | optional | |
github.event.issue.labels | array of objects | optional | |
github.event.issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.issue.labels.default | boolean | required | |
github.event.issue.labels.description | string or null | required | |
github.event.issue.labels.id | integer | required | |
github.event.issue.labels.name | string | required | The name of the label. |
github.event.issue.labels.node_id | string | required | |
github.event.issue.labels.url | string | required | URL for the label |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.issue.performed_via_github_app.created_at | string or null | required | |
github.event.issue.performed_via_github_app.description | string or null | required | |
github.event.issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.issue.performed_via_github_app.external_url | string or null | required | |
github.event.issue.performed_via_github_app.html_url | string | required | |
github.event.issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.issue.performed_via_github_app.node_id | string | required | |
github.event.issue.performed_via_github_app.owner | object or null | required | |
github.event.issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.issue.performed_via_github_app.owner.id | integer | required | |
github.event.issue.performed_via_github_app.owner.login | string | required | |
github.event.issue.performed_via_github_app.owner.name | string | optional | |
github.event.issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app.owner.url | string | optional | |
github.event.issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_projects | read , write , admin | optional | |
github.event.issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.issue.performed_via_github_app.updated_at | string or null | required | |
github.event.issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.issue.user.type | Bot , User , Organization , Mannequin | optional | |
github.event.label | object | optional | |
github.event.label.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.label.default | boolean | required | |
github.event.label.description | string or null | required | |
github.event.label.id | integer | required | |
github.event.label.name | string | required | The name of the label. |
github.event.label.node_id | string | required | |
github.event.label.url | string | required | URL for the label |
locked
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | locked | required | |
github.event.issue.labels | array of object,nulls | optional | |
github.event.issue.locked | True | required | |
github.event.issue.milestone.creator.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app | object or null | optional | |
github.event.issue.state | string | optional | |
github.event.issue.user.type | Bot , User , Organization | optional |
milestoned
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | milestoned | required | |
github.event.issue.labels | array of object,nulls | optional | |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.performed_via_github_app | object or null | optional | |
github.event.issue.state | string | optional | |
github.event.issue.user.type | Bot , User , Organization | optional | |
github.event.milestone | object | required | A collection of related issues and pull requests. |
github.event.milestone.closed_at | string or null | required | |
github.event.milestone.closed_issues | integer | required | |
github.event.milestone.created_at | string | required | |
github.event.milestone.creator | object or null | required | |
github.event.milestone.creator.avatar_url | string | optional | |
github.event.milestone.creator.deleted | boolean | optional | |
github.event.milestone.creator.email | string or null | optional | |
github.event.milestone.creator.events_url | string | optional | |
github.event.milestone.creator.followers_url | string | optional | |
github.event.milestone.creator.following_url | string | optional | |
github.event.milestone.creator.gists_url | string | optional | |
github.event.milestone.creator.gravatar_id | string | optional | |
github.event.milestone.creator.html_url | string | optional | |
github.event.milestone.creator.id | integer | required | |
github.event.milestone.creator.login | string | required | |
github.event.milestone.creator.name | string | optional | |
github.event.milestone.creator.node_id | string | optional | |
github.event.milestone.creator.organizations_url | string | optional | |
github.event.milestone.creator.received_events_url | string | optional | |
github.event.milestone.creator.repos_url | string | optional | |
github.event.milestone.creator.site_admin | boolean | optional | |
github.event.milestone.creator.starred_url | string | optional | |
github.event.milestone.creator.subscriptions_url | string | optional | |
github.event.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.milestone.creator.url | string | optional | |
github.event.milestone.description | string or null | required | |
github.event.milestone.due_on | string or null | required | |
github.event.milestone.html_url | string | required | |
github.event.milestone.id | integer | required | |
github.event.milestone.labels_url | string | required | |
github.event.milestone.node_id | string | required | |
github.event.milestone.number | integer | required | The number of the milestone. |
github.event.milestone.open_issues | integer | required | |
github.event.milestone.state | open , closed | required | The state of the milestone. |
github.event.milestone.title | string | required | The title of the milestone. |
github.event.milestone.updated_at | string | required | |
github.event.milestone.url | string | required |
opened
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | opened | required | |
github.event.changes | object | optional | |
github.event.changes.old_issue | object or null | required | The issue itself. |
github.event.changes.old_issue.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.changes.old_issue.assignee | object or null | optional | |
github.event.changes.old_issue.assignee.avatar_url | string | optional | |
github.event.changes.old_issue.assignee.deleted | boolean | optional | |
github.event.changes.old_issue.assignee.email | string or null | optional | |
github.event.changes.old_issue.assignee.events_url | string | optional | |
github.event.changes.old_issue.assignee.followers_url | string | optional | |
github.event.changes.old_issue.assignee.following_url | string | optional | |
github.event.changes.old_issue.assignee.gists_url | string | optional | |
github.event.changes.old_issue.assignee.gravatar_id | string | optional | |
github.event.changes.old_issue.assignee.html_url | string | optional | |
github.event.changes.old_issue.assignee.id | integer | required | |
github.event.changes.old_issue.assignee.login | string | required | |
github.event.changes.old_issue.assignee.name | string | optional | |
github.event.changes.old_issue.assignee.node_id | string | optional | |
github.event.changes.old_issue.assignee.organizations_url | string | optional | |
github.event.changes.old_issue.assignee.received_events_url | string | optional | |
github.event.changes.old_issue.assignee.repos_url | string | optional | |
github.event.changes.old_issue.assignee.site_admin | boolean | optional | |
github.event.changes.old_issue.assignee.starred_url | string | optional | |
github.event.changes.old_issue.assignee.subscriptions_url | string | optional | |
github.event.changes.old_issue.assignee.type | Bot , User , Organization | optional | |
github.event.changes.old_issue.assignee.url | string | optional | |
github.event.changes.old_issue.assignees | array of object,nulls | required | |
github.event.changes.old_issue.author_association | COLLABORATOR , CONTRIBUTOR , FIRST_TIMER , FIRST_TIME_CONTRIBUTOR , MANNEQUIN , MEMBER , NONE , OWNER | required | How the author is associated with the repository. |
github.event.changes.old_issue.body | string or null | required | Contents of the issue |
github.event.changes.old_issue.closed_at | string or null | required | |
github.event.changes.old_issue.comments | integer | required | |
github.event.changes.old_issue.comments_url | string | required | |
github.event.changes.old_issue.created_at | string | required | |
github.event.changes.old_issue.draft | boolean | optional | |
github.event.changes.old_issue.events_url | string | required | |
github.event.changes.old_issue.html_url | string | required | |
github.event.changes.old_issue.id | integer | required | |
github.event.changes.old_issue.labels | array of objects | optional | |
github.event.changes.old_issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.changes.old_issue.labels.default | boolean | required | |
github.event.changes.old_issue.labels.description | string or null | required | |
github.event.changes.old_issue.labels.id | integer | required | |
github.event.changes.old_issue.labels.name | string | required | The name of the label. |
github.event.changes.old_issue.labels.node_id | string | required | |
github.event.changes.old_issue.labels.url | string | required | URL for the label |
github.event.changes.old_issue.labels_url | string | required | |
github.event.changes.old_issue.locked | boolean | optional | |
github.event.changes.old_issue.milestone | object or null | required | A collection of related issues and pull requests. |
github.event.changes.old_issue.milestone.closed_at | string or null | required | |
github.event.changes.old_issue.milestone.closed_issues | integer | required | |
github.event.changes.old_issue.milestone.created_at | string | required | |
github.event.changes.old_issue.milestone.creator | object or null | required | |
github.event.changes.old_issue.milestone.creator.avatar_url | string | optional | |
github.event.changes.old_issue.milestone.creator.deleted | boolean | optional | |
github.event.changes.old_issue.milestone.creator.email | string or null | optional | |
github.event.changes.old_issue.milestone.creator.events_url | string | optional | |
github.event.changes.old_issue.milestone.creator.followers_url | string | optional | |
github.event.changes.old_issue.milestone.creator.following_url | string | optional | |
github.event.changes.old_issue.milestone.creator.gists_url | string | optional | |
github.event.changes.old_issue.milestone.creator.gravatar_id | string | optional | |
github.event.changes.old_issue.milestone.creator.html_url | string | optional | |
github.event.changes.old_issue.milestone.creator.id | integer | required | |
github.event.changes.old_issue.milestone.creator.login | string | required | |
github.event.changes.old_issue.milestone.creator.name | string | optional | |
github.event.changes.old_issue.milestone.creator.node_id | string | optional | |
github.event.changes.old_issue.milestone.creator.organizations_url | string | optional | |
github.event.changes.old_issue.milestone.creator.received_events_url | string | optional | |
github.event.changes.old_issue.milestone.creator.repos_url | string | optional | |
github.event.changes.old_issue.milestone.creator.site_admin | boolean | optional | |
github.event.changes.old_issue.milestone.creator.starred_url | string | optional | |
github.event.changes.old_issue.milestone.creator.subscriptions_url | string | optional | |
github.event.changes.old_issue.milestone.creator.type | Bot , User , Organization | optional | |
github.event.changes.old_issue.milestone.creator.url | string | optional | |
github.event.changes.old_issue.milestone.description | string or null | required | |
github.event.changes.old_issue.milestone.due_on | string or null | required | |
github.event.changes.old_issue.milestone.html_url | string | required | |
github.event.changes.old_issue.milestone.id | integer | required | |
github.event.changes.old_issue.milestone.labels_url | string | required | |
github.event.changes.old_issue.milestone.node_id | string | required | |
github.event.changes.old_issue.milestone.number | integer | required | The number of the milestone. |
github.event.changes.old_issue.milestone.open_issues | integer | required | |
github.event.changes.old_issue.milestone.state | open , closed | required | The state of the milestone. |
github.event.changes.old_issue.milestone.title | string | required | The title of the milestone. |
github.event.changes.old_issue.milestone.updated_at | string | required | |
github.event.changes.old_issue.milestone.url | string | required | |
github.event.changes.old_issue.node_id | string | required | |
github.event.changes.old_issue.number | integer | required | |
github.event.changes.old_issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.changes.old_issue.performed_via_github_app.created_at | string or null | required | |
github.event.changes.old_issue.performed_via_github_app.description | string or null | required | |
github.event.changes.old_issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.changes.old_issue.performed_via_github_app.external_url | string or null | required | |
github.event.changes.old_issue.performed_via_github_app.html_url | string | required | |
github.event.changes.old_issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.changes.old_issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.changes.old_issue.performed_via_github_app.node_id | string | required | |
github.event.changes.old_issue.performed_via_github_app.owner | object or null | required | |
github.event.changes.old_issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.id | integer | required | |
github.event.changes.old_issue.performed_via_github_app.owner.login | string | required | |
github.event.changes.old_issue.performed_via_github_app.owner.name | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.changes.old_issue.performed_via_github_app.owner.url | string | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.changes.old_issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.organization_projects | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.changes.old_issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.changes.old_issue.performed_via_github_app.updated_at | string or null | required | |
github.event.changes.old_issue.pull_request | object | optional | |
github.event.changes.old_issue.pull_request.diff_url | string | optional | |
github.event.changes.old_issue.pull_request.html_url | string | optional | |
github.event.changes.old_issue.pull_request.merged_at | string or null | optional | |
github.event.changes.old_issue.pull_request.patch_url | string | optional | |
github.event.changes.old_issue.pull_request.url | string | optional | |
github.event.changes.old_issue.reactions | object | required | |
github.event.changes.old_issue.reactions.+1 | integer | required | |
github.event.changes.old_issue.reactions.-1 | integer | required | |
github.event.changes.old_issue.reactions.confused | integer | required | |
github.event.changes.old_issue.reactions.eyes | integer | required | |
github.event.changes.old_issue.reactions.heart | integer | required | |
github.event.changes.old_issue.reactions.hooray | integer | required | |
github.event.changes.old_issue.reactions.laugh | integer | required | |
github.event.changes.old_issue.reactions.rocket | integer | required | |
github.event.changes.old_issue.reactions.total_count | integer | required | |
github.event.changes.old_issue.reactions.url | string | required | |
github.event.changes.old_issue.repository_url | string | required | |
github.event.changes.old_issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.changes.old_issue.state_reason | string or null | optional | |
github.event.changes.old_issue.timeline_url | string | optional | |
github.event.changes.old_issue.title | string | required | Title of the issue |
github.event.changes.old_issue.updated_at | string | required | |
github.event.changes.old_issue.url | string | required | URL for the issue |
github.event.changes.old_issue.user | object or null | required | |
github.event.changes.old_issue.user.avatar_url | string | optional | |
github.event.changes.old_issue.user.deleted | boolean | optional | |
github.event.changes.old_issue.user.email | string or null | optional | |
github.event.changes.old_issue.user.events_url | string | optional | |
github.event.changes.old_issue.user.followers_url | string | optional | |
github.event.changes.old_issue.user.following_url | string | optional | |
github.event.changes.old_issue.user.gists_url | string | optional | |
github.event.changes.old_issue.user.gravatar_id | string | optional | |
github.event.changes.old_issue.user.html_url | string | optional | |
github.event.changes.old_issue.user.id | integer | required | |
github.event.changes.old_issue.user.login | string | required | |
github.event.changes.old_issue.user.name | string | optional | |
github.event.changes.old_issue.user.node_id | string | optional | |
github.event.changes.old_issue.user.organizations_url | string | optional | |
github.event.changes.old_issue.user.received_events_url | string | optional | |
github.event.changes.old_issue.user.repos_url | string | optional | |
github.event.changes.old_issue.user.site_admin | boolean | optional | |
github.event.changes.old_issue.user.starred_url | string | optional | |
github.event.changes.old_issue.user.subscriptions_url | string | optional | |
github.event.changes.old_issue.user.type | Bot , User , Organization | optional | |
github.event.changes.old_issue.user.url | string | optional | |
github.event.changes.old_repository | object | required | A git repository |
github.event.changes.old_repository.allow_auto_merge | boolean | optional | Whether to allow auto-merge for pull requests. |
github.event.changes.old_repository.allow_forking | boolean | optional | Whether to allow private forks |
github.event.changes.old_repository.allow_merge_commit | boolean | optional | Whether to allow merge commits for pull requests. |
github.event.changes.old_repository.allow_rebase_merge | boolean | optional | Whether to allow rebase merges for pull requests. |
github.event.changes.old_repository.allow_squash_merge | boolean | optional | Whether to allow squash merges for pull requests. |
github.event.changes.old_repository.allow_update_branch | boolean | optional | |
github.event.changes.old_repository.archive_url | string | required | |
github.event.changes.old_repository.archived | boolean | required | Whether the repository is archived. |
github.event.changes.old_repository.assignees_url | string | required | |
github.event.changes.old_repository.blobs_url | string | required | |
github.event.changes.old_repository.branches_url | string | required | |
github.event.changes.old_repository.clone_url | string | required | |
github.event.changes.old_repository.collaborators_url | string | required | |
github.event.changes.old_repository.comments_url | string | required | |
github.event.changes.old_repository.commits_url | string | required | |
github.event.changes.old_repository.compare_url | string | required | |
github.event.changes.old_repository.contents_url | string | required | |
github.event.changes.old_repository.contributors_url | string | required | |
github.event.changes.old_repository.created_at | integer or string | required | |
github.event.changes.old_repository.custom_properties | object | optional | The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. |
github.event.changes.old_repository.default_branch | string | required | The default branch of the repository. |
github.event.changes.old_repository.delete_branch_on_merge | boolean | optional | Whether to delete head branches when pull requests are merged |
github.event.changes.old_repository.deployments_url | string | required | |
github.event.changes.old_repository.description | string or null | required | |
github.event.changes.old_repository.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.changes.old_repository.downloads_url | string | required | |
github.event.changes.old_repository.events_url | string | required | |
github.event.changes.old_repository.fork | boolean | required | |
github.event.changes.old_repository.forks | integer | required | |
github.event.changes.old_repository.forks_count | integer | required | |
github.event.changes.old_repository.forks_url | string | required | |
github.event.changes.old_repository.full_name | string | required | |
github.event.changes.old_repository.git_commits_url | string | required | |
github.event.changes.old_repository.git_refs_url | string | required | |
github.event.changes.old_repository.git_tags_url | string | required | |
github.event.changes.old_repository.git_url | string | required | |
github.event.changes.old_repository.has_discussions | boolean | optional | Whether the repository has discussions enabled. |
github.event.changes.old_repository.has_downloads | boolean | required | Whether downloads are enabled. |
github.event.changes.old_repository.has_issues | boolean | required | Whether issues are enabled. |
github.event.changes.old_repository.has_pages | boolean | required | |
github.event.changes.old_repository.has_projects | boolean | required | Whether projects are enabled. |
github.event.changes.old_repository.has_wiki | boolean | required | Whether the wiki is enabled. |
github.event.changes.old_repository.homepage | string or null | required | |
github.event.changes.old_repository.hooks_url | string | required | |
github.event.changes.old_repository.html_url | string | required | |
github.event.changes.old_repository.id | integer | required | Unique identifier of the repository |
github.event.changes.old_repository.is_template | boolean | optional | |
github.event.changes.old_repository.issue_comment_url | string | required | |
github.event.changes.old_repository.issue_events_url | string | required | |
github.event.changes.old_repository.issues_url | string | required | |
github.event.changes.old_repository.keys_url | string | required | |
github.event.changes.old_repository.labels_url | string | required | |
github.event.changes.old_repository.language | string or null | required | |
github.event.changes.old_repository.languages_url | string | required | |
github.event.changes.old_repository.license | object or null | required | |
github.event.changes.old_repository.license.key | string | required | |
github.event.changes.old_repository.license.name | string | required | |
github.event.changes.old_repository.license.node_id | string | required | |
github.event.changes.old_repository.license.spdx_id | string | required | |
github.event.changes.old_repository.license.url | string or null | required | |
github.event.changes.old_repository.master_branch | string | optional | |
github.event.changes.old_repository.merges_url | string | required | |
github.event.changes.old_repository.milestones_url | string | required | |
github.event.changes.old_repository.mirror_url | string or null | required | |
github.event.changes.old_repository.name | string | required | The name of the repository. |
github.event.changes.old_repository.node_id | string | required | |
github.event.changes.old_repository.notifications_url | string | required | |
github.event.changes.old_repository.open_issues | integer | required | |
github.event.changes.old_repository.open_issues_count | integer | required | |
github.event.changes.old_repository.organization | string | optional | |
github.event.changes.old_repository.owner | object or null | required | |
github.event.changes.old_repository.owner.avatar_url | string | optional | |
github.event.changes.old_repository.owner.deleted | boolean | optional | |
github.event.changes.old_repository.owner.email | string or null | optional | |
github.event.changes.old_repository.owner.events_url | string | optional | |
github.event.changes.old_repository.owner.followers_url | string | optional | |
github.event.changes.old_repository.owner.following_url | string | optional | |
github.event.changes.old_repository.owner.gists_url | string | optional | |
github.event.changes.old_repository.owner.gravatar_id | string | optional | |
github.event.changes.old_repository.owner.html_url | string | optional | |
github.event.changes.old_repository.owner.id | integer | required | |
github.event.changes.old_repository.owner.login | string | required | |
github.event.changes.old_repository.owner.name | string | optional | |
github.event.changes.old_repository.owner.node_id | string | optional | |
github.event.changes.old_repository.owner.organizations_url | string | optional | |
github.event.changes.old_repository.owner.received_events_url | string | optional | |
github.event.changes.old_repository.owner.repos_url | string | optional | |
github.event.changes.old_repository.owner.site_admin | boolean | optional | |
github.event.changes.old_repository.owner.starred_url | string | optional | |
github.event.changes.old_repository.owner.subscriptions_url | string | optional | |
github.event.changes.old_repository.owner.type | Bot , User , Organization | optional | |
github.event.changes.old_repository.owner.url | string | optional | |
github.event.changes.old_repository.permissions | object | optional | |
github.event.changes.old_repository.permissions.admin | boolean | required | |
github.event.changes.old_repository.permissions.maintain | boolean | optional | |
github.event.changes.old_repository.permissions.pull | boolean | required | |
github.event.changes.old_repository.permissions.push | boolean | required | |
github.event.changes.old_repository.permissions.triage | boolean | optional | |
github.event.changes.old_repository.private | boolean | required | Whether the repository is private or public. |
github.event.changes.old_repository.public | boolean | optional | |
github.event.changes.old_repository.pulls_url | string | required | |
github.event.changes.old_repository.pushed_at | null or integer or string | required | |
github.event.changes.old_repository.releases_url | string | required | |
github.event.changes.old_repository.role_name | string or null | optional | |
github.event.changes.old_repository.size | integer | required | |
github.event.changes.old_repository.ssh_url | string | required | |
github.event.changes.old_repository.stargazers | integer | optional | |
github.event.changes.old_repository.stargazers_count | integer | required | |
github.event.changes.old_repository.stargazers_url | string | required | |
github.event.changes.old_repository.statuses_url | string | required | |
github.event.changes.old_repository.subscribers_url | string | required | |
github.event.changes.old_repository.subscription_url | string | required | |
github.event.changes.old_repository.svn_url | string | required | |
github.event.changes.old_repository.tags_url | string | required | |
github.event.changes.old_repository.teams_url | string | required | |
github.event.changes.old_repository.topics | array of strings | required | |
github.event.changes.old_repository.trees_url | string | required | |
github.event.changes.old_repository.updated_at | string | required | |
github.event.changes.old_repository.url | string | required | |
github.event.changes.old_repository.visibility | public , private , internal | required | |
github.event.changes.old_repository.watchers | integer | required | |
github.event.changes.old_repository.watchers_count | integer | required | |
github.event.changes.old_repository.web_commit_signoff_required | boolean | optional | Whether to require commit signoff. |
github.event.issue.assignee.avatar_url | string | optional | |
github.event.issue.assignee.deleted | boolean | optional | |
github.event.issue.assignee.email | string or null | optional | |
github.event.issue.assignee.events_url | string | optional | |
github.event.issue.assignee.followers_url | string | optional | |
github.event.issue.assignee.following_url | string | optional | |
github.event.issue.assignee.gists_url | string | optional | |
github.event.issue.assignee.gravatar_id | string | optional | |
github.event.issue.assignee.html_url | string | optional | |
github.event.issue.assignee.id | integer | required | |
github.event.issue.assignee.login | string | required | |
github.event.issue.assignee.name | string | optional | |
github.event.issue.assignee.node_id | string | optional | |
github.event.issue.assignee.organizations_url | string | optional | |
github.event.issue.assignee.received_events_url | string | optional | |
github.event.issue.assignee.repos_url | string | optional | |
github.event.issue.assignee.site_admin | boolean | optional | |
github.event.issue.assignee.starred_url | string | optional | |
github.event.issue.assignee.subscriptions_url | string | optional | |
github.event.issue.assignee.type | Bot , User , Organization | optional | |
github.event.issue.assignee.url | string | optional | |
github.event.issue.labels | array of objects | optional | |
github.event.issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.issue.labels.default | boolean | required | |
github.event.issue.labels.description | string or null | required | |
github.event.issue.labels.id | integer | required | |
github.event.issue.labels.name | string | required | The name of the label. |
github.event.issue.labels.node_id | string | required | |
github.event.issue.labels.url | string | required | URL for the label |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.issue.performed_via_github_app.created_at | string or null | required | |
github.event.issue.performed_via_github_app.description | string or null | required | |
github.event.issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.issue.performed_via_github_app.external_url | string or null | required | |
github.event.issue.performed_via_github_app.html_url | string | required | |
github.event.issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.issue.performed_via_github_app.node_id | string | required | |
github.event.issue.performed_via_github_app.owner | object or null | required | |
github.event.issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.issue.performed_via_github_app.owner.id | integer | required | |
github.event.issue.performed_via_github_app.owner.login | string | required | |
github.event.issue.performed_via_github_app.owner.name | string | optional | |
github.event.issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app.owner.url | string | optional | |
github.event.issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_projects | read , write , admin | optional | |
github.event.issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.issue.performed_via_github_app.updated_at | string or null | required | |
github.event.issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.issue.user.type | Bot , User , Organization | optional |
pinned
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | pinned | required | |
github.event.issue.assignee.avatar_url | string | optional | |
github.event.issue.assignee.deleted | boolean | optional | |
github.event.issue.assignee.email | string or null | optional | |
github.event.issue.assignee.events_url | string | optional | |
github.event.issue.assignee.followers_url | string | optional | |
github.event.issue.assignee.following_url | string | optional | |
github.event.issue.assignee.gists_url | string | optional | |
github.event.issue.assignee.gravatar_id | string | optional | |
github.event.issue.assignee.html_url | string | optional | |
github.event.issue.assignee.id | integer | required | |
github.event.issue.assignee.login | string | required | |
github.event.issue.assignee.name | string | optional | |
github.event.issue.assignee.node_id | string | optional | |
github.event.issue.assignee.organizations_url | string | optional | |
github.event.issue.assignee.received_events_url | string | optional | |
github.event.issue.assignee.repos_url | string | optional | |
github.event.issue.assignee.site_admin | boolean | optional | |
github.event.issue.assignee.starred_url | string | optional | |
github.event.issue.assignee.subscriptions_url | string | optional | |
github.event.issue.assignee.type | Bot , User , Organization | optional | |
github.event.issue.assignee.url | string | optional | |
github.event.issue.labels | array of objects | optional | |
github.event.issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.issue.labels.default | boolean | required | |
github.event.issue.labels.description | string or null | required | |
github.event.issue.labels.id | integer | required | |
github.event.issue.labels.name | string | required | The name of the label. |
github.event.issue.labels.node_id | string | required | |
github.event.issue.labels.url | string | required | URL for the label |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.issue.performed_via_github_app.created_at | string or null | required | |
github.event.issue.performed_via_github_app.description | string or null | required | |
github.event.issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.issue.performed_via_github_app.external_url | string or null | required | |
github.event.issue.performed_via_github_app.html_url | string | required | |
github.event.issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.issue.performed_via_github_app.node_id | string | required | |
github.event.issue.performed_via_github_app.owner | object or null | required | |
github.event.issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.issue.performed_via_github_app.owner.id | integer | required | |
github.event.issue.performed_via_github_app.owner.login | string | required | |
github.event.issue.performed_via_github_app.owner.name | string | optional | |
github.event.issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app.owner.url | string | optional | |
github.event.issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.issue.performed_via_github_app.updated_at | string or null | required | |
github.event.issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.issue.user.type | Bot , User , Organization | optional |
reopened
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | reopened | required | |
github.event.issue.labels | array of object,nulls | optional | |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.performed_via_github_app | object or null | optional | |
github.event.issue.state | open , closed | required | |
github.event.issue.user.type | Bot , User , Organization , Mannequin | optional |
transferred
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | transferred | required | |
github.event.changes | object | required | |
github.event.changes.new_issue | object | required | The issue itself. |
github.event.changes.new_issue.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.changes.new_issue.assignee | object or null | optional | |
github.event.changes.new_issue.assignee.avatar_url | string | optional | |
github.event.changes.new_issue.assignee.deleted | boolean | optional | |
github.event.changes.new_issue.assignee.email | string or null | optional | |
github.event.changes.new_issue.assignee.events_url | string | optional | |
github.event.changes.new_issue.assignee.followers_url | string | optional | |
github.event.changes.new_issue.assignee.following_url | string | optional | |
github.event.changes.new_issue.assignee.gists_url | string | optional | |
github.event.changes.new_issue.assignee.gravatar_id | string | optional | |
github.event.changes.new_issue.assignee.html_url | string | optional | |
github.event.changes.new_issue.assignee.id | integer | required | |
github.event.changes.new_issue.assignee.login | string | required | |
github.event.changes.new_issue.assignee.name | string | optional | |
github.event.changes.new_issue.assignee.node_id | string | optional | |
github.event.changes.new_issue.assignee.organizations_url | string | optional | |
github.event.changes.new_issue.assignee.received_events_url | string | optional | |
github.event.changes.new_issue.assignee.repos_url | string | optional | |
github.event.changes.new_issue.assignee.site_admin | boolean | optional | |
github.event.changes.new_issue.assignee.starred_url | string | optional | |
github.event.changes.new_issue.assignee.subscriptions_url | string | optional | |
github.event.changes.new_issue.assignee.type | Bot , User , Organization | optional | |
github.event.changes.new_issue.assignee.url | string | optional | |
github.event.changes.new_issue.assignees | array of object,nulls | required | |
github.event.changes.new_issue.author_association | COLLABORATOR , CONTRIBUTOR , FIRST_TIMER , FIRST_TIME_CONTRIBUTOR , MANNEQUIN , MEMBER , NONE , OWNER | required | How the author is associated with the repository. |
github.event.changes.new_issue.body | string or null | required | Contents of the issue |
github.event.changes.new_issue.closed_at | string or null | required | |
github.event.changes.new_issue.comments | integer | required | |
github.event.changes.new_issue.comments_url | string | required | |
github.event.changes.new_issue.created_at | string | required | |
github.event.changes.new_issue.draft | boolean | optional | |
github.event.changes.new_issue.events_url | string | required | |
github.event.changes.new_issue.html_url | string | required | |
github.event.changes.new_issue.id | integer | required | |
github.event.changes.new_issue.labels | array of objects | optional | |
github.event.changes.new_issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.changes.new_issue.labels.default | boolean | required | |
github.event.changes.new_issue.labels.description | string or null | required | |
github.event.changes.new_issue.labels.id | integer | required | |
github.event.changes.new_issue.labels.name | string | required | The name of the label. |
github.event.changes.new_issue.labels.node_id | string | required | |
github.event.changes.new_issue.labels.url | string | required | URL for the label |
github.event.changes.new_issue.labels_url | string | required | |
github.event.changes.new_issue.locked | boolean | optional | |
github.event.changes.new_issue.milestone | object or null | required | A collection of related issues and pull requests. |
github.event.changes.new_issue.milestone.closed_at | string or null | required | |
github.event.changes.new_issue.milestone.closed_issues | integer | required | |
github.event.changes.new_issue.milestone.created_at | string | required | |
github.event.changes.new_issue.milestone.creator | object or null | required | |
github.event.changes.new_issue.milestone.creator.avatar_url | string | optional | |
github.event.changes.new_issue.milestone.creator.deleted | boolean | optional | |
github.event.changes.new_issue.milestone.creator.email | string or null | optional | |
github.event.changes.new_issue.milestone.creator.events_url | string | optional | |
github.event.changes.new_issue.milestone.creator.followers_url | string | optional | |
github.event.changes.new_issue.milestone.creator.following_url | string | optional | |
github.event.changes.new_issue.milestone.creator.gists_url | string | optional | |
github.event.changes.new_issue.milestone.creator.gravatar_id | string | optional | |
github.event.changes.new_issue.milestone.creator.html_url | string | optional | |
github.event.changes.new_issue.milestone.creator.id | integer | required | |
github.event.changes.new_issue.milestone.creator.login | string | required | |
github.event.changes.new_issue.milestone.creator.name | string | optional | |
github.event.changes.new_issue.milestone.creator.node_id | string | optional | |
github.event.changes.new_issue.milestone.creator.organizations_url | string | optional | |
github.event.changes.new_issue.milestone.creator.received_events_url | string | optional | |
github.event.changes.new_issue.milestone.creator.repos_url | string | optional | |
github.event.changes.new_issue.milestone.creator.site_admin | boolean | optional | |
github.event.changes.new_issue.milestone.creator.starred_url | string | optional | |
github.event.changes.new_issue.milestone.creator.subscriptions_url | string | optional | |
github.event.changes.new_issue.milestone.creator.type | Bot , User , Organization | optional | |
github.event.changes.new_issue.milestone.creator.url | string | optional | |
github.event.changes.new_issue.milestone.description | string or null | required | |
github.event.changes.new_issue.milestone.due_on | string or null | required | |
github.event.changes.new_issue.milestone.html_url | string | required | |
github.event.changes.new_issue.milestone.id | integer | required | |
github.event.changes.new_issue.milestone.labels_url | string | required | |
github.event.changes.new_issue.milestone.node_id | string | required | |
github.event.changes.new_issue.milestone.number | integer | required | The number of the milestone. |
github.event.changes.new_issue.milestone.open_issues | integer | required | |
github.event.changes.new_issue.milestone.state | open , closed | required | The state of the milestone. |
github.event.changes.new_issue.milestone.title | string | required | The title of the milestone. |
github.event.changes.new_issue.milestone.updated_at | string | required | |
github.event.changes.new_issue.milestone.url | string | required | |
github.event.changes.new_issue.node_id | string | required | |
github.event.changes.new_issue.number | integer | required | |
github.event.changes.new_issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.changes.new_issue.performed_via_github_app.created_at | string or null | required | |
github.event.changes.new_issue.performed_via_github_app.description | string or null | required | |
github.event.changes.new_issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.changes.new_issue.performed_via_github_app.external_url | string or null | required | |
github.event.changes.new_issue.performed_via_github_app.html_url | string | required | |
github.event.changes.new_issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.changes.new_issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.changes.new_issue.performed_via_github_app.node_id | string | required | |
github.event.changes.new_issue.performed_via_github_app.owner | object or null | required | |
github.event.changes.new_issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.id | integer | required | |
github.event.changes.new_issue.performed_via_github_app.owner.login | string | required | |
github.event.changes.new_issue.performed_via_github_app.owner.name | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.changes.new_issue.performed_via_github_app.owner.url | string | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.changes.new_issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.organization_projects | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.changes.new_issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.changes.new_issue.performed_via_github_app.updated_at | string or null | required | |
github.event.changes.new_issue.pull_request | object | optional | |
github.event.changes.new_issue.pull_request.diff_url | string | optional | |
github.event.changes.new_issue.pull_request.html_url | string | optional | |
github.event.changes.new_issue.pull_request.merged_at | string or null | optional | |
github.event.changes.new_issue.pull_request.patch_url | string | optional | |
github.event.changes.new_issue.pull_request.url | string | optional | |
github.event.changes.new_issue.reactions | object | required | |
github.event.changes.new_issue.reactions.+1 | integer | required | |
github.event.changes.new_issue.reactions.-1 | integer | required | |
github.event.changes.new_issue.reactions.confused | integer | required | |
github.event.changes.new_issue.reactions.eyes | integer | required | |
github.event.changes.new_issue.reactions.heart | integer | required | |
github.event.changes.new_issue.reactions.hooray | integer | required | |
github.event.changes.new_issue.reactions.laugh | integer | required | |
github.event.changes.new_issue.reactions.rocket | integer | required | |
github.event.changes.new_issue.reactions.total_count | integer | required | |
github.event.changes.new_issue.reactions.url | string | required | |
github.event.changes.new_issue.repository_url | string | required | |
github.event.changes.new_issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.changes.new_issue.state_reason | string or null | optional | |
github.event.changes.new_issue.timeline_url | string | optional | |
github.event.changes.new_issue.title | string | required | Title of the issue |
github.event.changes.new_issue.updated_at | string | required | |
github.event.changes.new_issue.url | string | required | URL for the issue |
github.event.changes.new_issue.user | object or null | required | |
github.event.changes.new_issue.user.avatar_url | string | optional | |
github.event.changes.new_issue.user.deleted | boolean | optional | |
github.event.changes.new_issue.user.email | string or null | optional | |
github.event.changes.new_issue.user.events_url | string | optional | |
github.event.changes.new_issue.user.followers_url | string | optional | |
github.event.changes.new_issue.user.following_url | string | optional | |
github.event.changes.new_issue.user.gists_url | string | optional | |
github.event.changes.new_issue.user.gravatar_id | string | optional | |
github.event.changes.new_issue.user.html_url | string | optional | |
github.event.changes.new_issue.user.id | integer | required | |
github.event.changes.new_issue.user.login | string | required | |
github.event.changes.new_issue.user.name | string | optional | |
github.event.changes.new_issue.user.node_id | string | optional | |
github.event.changes.new_issue.user.organizations_url | string | optional | |
github.event.changes.new_issue.user.received_events_url | string | optional | |
github.event.changes.new_issue.user.repos_url | string | optional | |
github.event.changes.new_issue.user.site_admin | boolean | optional | |
github.event.changes.new_issue.user.starred_url | string | optional | |
github.event.changes.new_issue.user.subscriptions_url | string | optional | |
github.event.changes.new_issue.user.type | Bot , User , Organization | optional | |
github.event.changes.new_issue.user.url | string | optional | |
github.event.changes.new_repository | object | required | A git repository |
github.event.changes.new_repository.allow_auto_merge | boolean | optional | Whether to allow auto-merge for pull requests. |
github.event.changes.new_repository.allow_forking | boolean | optional | Whether to allow private forks |
github.event.changes.new_repository.allow_merge_commit | boolean | optional | Whether to allow merge commits for pull requests. |
github.event.changes.new_repository.allow_rebase_merge | boolean | optional | Whether to allow rebase merges for pull requests. |
github.event.changes.new_repository.allow_squash_merge | boolean | optional | Whether to allow squash merges for pull requests. |
github.event.changes.new_repository.allow_update_branch | boolean | optional | |
github.event.changes.new_repository.archive_url | string | required | |
github.event.changes.new_repository.archived | boolean | required | Whether the repository is archived. |
github.event.changes.new_repository.assignees_url | string | required | |
github.event.changes.new_repository.blobs_url | string | required | |
github.event.changes.new_repository.branches_url | string | required | |
github.event.changes.new_repository.clone_url | string | required | |
github.event.changes.new_repository.collaborators_url | string | required | |
github.event.changes.new_repository.comments_url | string | required | |
github.event.changes.new_repository.commits_url | string | required | |
github.event.changes.new_repository.compare_url | string | required | |
github.event.changes.new_repository.contents_url | string | required | |
github.event.changes.new_repository.contributors_url | string | required | |
github.event.changes.new_repository.created_at | integer or string | required | |
github.event.changes.new_repository.custom_properties | object | optional | The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. |
github.event.changes.new_repository.default_branch | string | required | The default branch of the repository. |
github.event.changes.new_repository.delete_branch_on_merge | boolean | optional | Whether to delete head branches when pull requests are merged |
github.event.changes.new_repository.deployments_url | string | required | |
github.event.changes.new_repository.description | string or null | required | |
github.event.changes.new_repository.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.changes.new_repository.downloads_url | string | required | |
github.event.changes.new_repository.events_url | string | required | |
github.event.changes.new_repository.fork | boolean | required | |
github.event.changes.new_repository.forks | integer | required | |
github.event.changes.new_repository.forks_count | integer | required | |
github.event.changes.new_repository.forks_url | string | required | |
github.event.changes.new_repository.full_name | string | required | |
github.event.changes.new_repository.git_commits_url | string | required | |
github.event.changes.new_repository.git_refs_url | string | required | |
github.event.changes.new_repository.git_tags_url | string | required | |
github.event.changes.new_repository.git_url | string | required | |
github.event.changes.new_repository.has_downloads | boolean | required | Whether downloads are enabled. |
github.event.changes.new_repository.has_issues | boolean | required | Whether issues are enabled. |
github.event.changes.new_repository.has_pages | boolean | required | |
github.event.changes.new_repository.has_projects | boolean | required | Whether projects are enabled. |
github.event.changes.new_repository.has_wiki | boolean | required | Whether the wiki is enabled. |
github.event.changes.new_repository.has_discussions | boolean | required | Whether discussions are enabled. |
github.event.changes.new_repository.homepage | string or null | required | |
github.event.changes.new_repository.hooks_url | string | required | |
github.event.changes.new_repository.html_url | string | required | |
github.event.changes.new_repository.id | integer | required | Unique identifier of the repository |
github.event.changes.new_repository.is_template | boolean | optional | |
github.event.changes.new_repository.issue_comment_url | string | required | |
github.event.changes.new_repository.issue_events_url | string | required | |
github.event.changes.new_repository.issues_url | string | required | |
github.event.changes.new_repository.keys_url | string | required | |
github.event.changes.new_repository.labels_url | string | required | |
github.event.changes.new_repository.language | string or null | required | |
github.event.changes.new_repository.languages_url | string | required | |
github.event.changes.new_repository.license | object or null | required | |
github.event.changes.new_repository.license.key | string | required | |
github.event.changes.new_repository.license.name | string | required | |
github.event.changes.new_repository.license.node_id | string | required | |
github.event.changes.new_repository.license.spdx_id | string | required | |
github.event.changes.new_repository.license.url | string or null | required | |
github.event.changes.new_repository.master_branch | string | optional | |
github.event.changes.new_repository.merges_url | string | required | |
github.event.changes.new_repository.milestones_url | string | required | |
github.event.changes.new_repository.mirror_url | string or null | required | |
github.event.changes.new_repository.name | string | required | The name of the repository. |
github.event.changes.new_repository.node_id | string | required | |
github.event.changes.new_repository.notifications_url | string | required | |
github.event.changes.new_repository.open_issues | integer | required | |
github.event.changes.new_repository.open_issues_count | integer | required | |
github.event.changes.new_repository.organization | string | optional | |
github.event.changes.new_repository.owner | object or null | required | |
github.event.changes.new_repository.owner.avatar_url | string | optional | |
github.event.changes.new_repository.owner.deleted | boolean | optional | |
github.event.changes.new_repository.owner.email | string or null | optional | |
github.event.changes.new_repository.owner.events_url | string | optional | |
github.event.changes.new_repository.owner.followers_url | string | optional | |
github.event.changes.new_repository.owner.following_url | string | optional | |
github.event.changes.new_repository.owner.gists_url | string | optional | |
github.event.changes.new_repository.owner.gravatar_id | string | optional | |
github.event.changes.new_repository.owner.html_url | string | optional | |
github.event.changes.new_repository.owner.id | integer | required | |
github.event.changes.new_repository.owner.login | string | required | |
github.event.changes.new_repository.owner.name | string | optional | |
github.event.changes.new_repository.owner.node_id | string | optional | |
github.event.changes.new_repository.owner.organizations_url | string | optional | |
github.event.changes.new_repository.owner.received_events_url | string | optional | |
github.event.changes.new_repository.owner.repos_url | string | optional | |
github.event.changes.new_repository.owner.site_admin | boolean | optional | |
github.event.changes.new_repository.owner.starred_url | string | optional | |
github.event.changes.new_repository.owner.subscriptions_url | string | optional | |
github.event.changes.new_repository.owner.type | Bot , User , Organization | optional | |
github.event.changes.new_repository.owner.url | string | optional | |
github.event.changes.new_repository.permissions | object | optional | |
github.event.changes.new_repository.permissions.admin | boolean | required | |
github.event.changes.new_repository.permissions.maintain | boolean | optional | |
github.event.changes.new_repository.permissions.pull | boolean | required | |
github.event.changes.new_repository.permissions.push | boolean | required | |
github.event.changes.new_repository.permissions.triage | boolean | optional | |
github.event.changes.new_repository.private | boolean | required | Whether the repository is private or public. |
github.event.changes.new_repository.public | boolean | optional | |
github.event.changes.new_repository.pulls_url | string | required | |
github.event.changes.new_repository.pushed_at | null or integer or string | required | |
github.event.changes.new_repository.releases_url | string | required | |
github.event.changes.new_repository.role_name | string or null | optional | |
github.event.changes.new_repository.size | integer | required | |
github.event.changes.new_repository.ssh_url | string | required | |
github.event.changes.new_repository.stargazers | integer | optional | |
github.event.changes.new_repository.stargazers_count | integer | required | |
github.event.changes.new_repository.stargazers_url | string | required | |
github.event.changes.new_repository.statuses_url | string | required | |
github.event.changes.new_repository.subscribers_url | string | required | |
github.event.changes.new_repository.subscription_url | string | required | |
github.event.changes.new_repository.svn_url | string | required | |
github.event.changes.new_repository.tags_url | string | required | |
github.event.changes.new_repository.teams_url | string | required | |
github.event.changes.new_repository.topics | array of strings | required | |
github.event.changes.new_repository.trees_url | string | required | |
github.event.changes.new_repository.updated_at | string | required | |
github.event.changes.new_repository.url | string | required | |
github.event.changes.new_repository.visibility | public , private , internal | required | |
github.event.changes.new_repository.watchers | integer | required | |
github.event.changes.new_repository.watchers_count | integer | required | |
github.event.changes.new_repository.web_commit_signoff_required | boolean | optional | Whether to require contributors to sign off on web-based commits |
github.event.issue.assignee.avatar_url | string | optional | |
github.event.issue.assignee.deleted | boolean | optional | |
github.event.issue.assignee.email | string or null | optional | |
github.event.issue.assignee.events_url | string | optional | |
github.event.issue.assignee.followers_url | string | optional | |
github.event.issue.assignee.following_url | string | optional | |
github.event.issue.assignee.gists_url | string | optional | |
github.event.issue.assignee.gravatar_id | string | optional | |
github.event.issue.assignee.html_url | string | optional | |
github.event.issue.assignee.id | integer | required | |
github.event.issue.assignee.login | string | required | |
github.event.issue.assignee.name | string | optional | |
github.event.issue.assignee.node_id | string | optional | |
github.event.issue.assignee.organizations_url | string | optional | |
github.event.issue.assignee.received_events_url | string | optional | |
github.event.issue.assignee.repos_url | string | optional | |
github.event.issue.assignee.site_admin | boolean | optional | |
github.event.issue.assignee.starred_url | string | optional | |
github.event.issue.assignee.subscriptions_url | string | optional | |
github.event.issue.assignee.type | Bot , User , Organization | optional | |
github.event.issue.assignee.url | string | optional | |
github.event.issue.labels | array of objects | optional | |
github.event.issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.issue.labels.default | boolean | required | |
github.event.issue.labels.description | string or null | required | |
github.event.issue.labels.id | integer | required | |
github.event.issue.labels.name | string | required | The name of the label. |
github.event.issue.labels.node_id | string | required | |
github.event.issue.labels.url | string | required | URL for the label |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.issue.performed_via_github_app.created_at | string or null | required | |
github.event.issue.performed_via_github_app.description | string or null | required | |
github.event.issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.issue.performed_via_github_app.external_url | string or null | required | |
github.event.issue.performed_via_github_app.html_url | string | required | |
github.event.issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.issue.performed_via_github_app.node_id | string | required | |
github.event.issue.performed_via_github_app.owner | object or null | required | |
github.event.issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.issue.performed_via_github_app.owner.id | integer | required | |
github.event.issue.performed_via_github_app.owner.login | string | required | |
github.event.issue.performed_via_github_app.owner.name | string | optional | |
github.event.issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app.owner.url | string | optional | |
github.event.issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.issue.performed_via_github_app.updated_at | string or null | required | |
github.event.issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.issue.user.type | Bot , User , Organization | optional |
unassigned
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | unassigned | required | The action that was performed. |
github.event.assignee | object or null | optional | |
github.event.assignee.avatar_url | string | optional | |
github.event.assignee.deleted | boolean | optional | |
github.event.assignee.email | string or null | optional | |
github.event.assignee.events_url | string | optional | |
github.event.assignee.followers_url | string | optional | |
github.event.assignee.following_url | string | optional | |
github.event.assignee.gists_url | string | optional | |
github.event.assignee.gravatar_id | string | optional | |
github.event.assignee.html_url | string | optional | |
github.event.assignee.id | integer | required | |
github.event.assignee.login | string | required | |
github.event.assignee.name | string | optional | |
github.event.assignee.node_id | string | optional | |
github.event.assignee.organizations_url | string | optional | |
github.event.assignee.received_events_url | string | optional | |
github.event.assignee.repos_url | string | optional | |
github.event.assignee.site_admin | boolean | optional | |
github.event.assignee.starred_url | string | optional | |
github.event.assignee.subscriptions_url | string | optional | |
github.event.assignee.type | Bot , User , Organization , Mannequin | optional | |
github.event.assignee.url | string | optional | |
github.event.issue.assignee.avatar_url | string | optional | |
github.event.issue.assignee.deleted | boolean | optional | |
github.event.issue.assignee.email | string or null | optional | |
github.event.issue.assignee.events_url | string | optional | |
github.event.issue.assignee.followers_url | string | optional | |
github.event.issue.assignee.following_url | string | optional | |
github.event.issue.assignee.gists_url | string | optional | |
github.event.issue.assignee.gravatar_id | string | optional | |
github.event.issue.assignee.html_url | string | optional | |
github.event.issue.assignee.id | integer | required | |
github.event.issue.assignee.login | string | required | |
github.event.issue.assignee.name | string | optional | |
github.event.issue.assignee.node_id | string | optional | |
github.event.issue.assignee.organizations_url | string | optional | |
github.event.issue.assignee.received_events_url | string | optional | |
github.event.issue.assignee.repos_url | string | optional | |
github.event.issue.assignee.site_admin | boolean | optional | |
github.event.issue.assignee.starred_url | string | optional | |
github.event.issue.assignee.subscriptions_url | string | optional | |
github.event.issue.assignee.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.assignee.url | string | optional | |
github.event.issue.labels | array of objects | optional | |
github.event.issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.issue.labels.default | boolean | required | |
github.event.issue.labels.description | string or null | required | |
github.event.issue.labels.id | integer | required | |
github.event.issue.labels.name | string | required | The name of the label. |
github.event.issue.labels.node_id | string | required | |
github.event.issue.labels.url | string | required | URL for the label |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.issue.performed_via_github_app.created_at | string or null | required | |
github.event.issue.performed_via_github_app.description | string or null | required | |
github.event.issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.issue.performed_via_github_app.external_url | string or null | required | |
github.event.issue.performed_via_github_app.html_url | string | required | |
github.event.issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.issue.performed_via_github_app.node_id | string | required | |
github.event.issue.performed_via_github_app.owner | object or null | required | |
github.event.issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.issue.performed_via_github_app.owner.id | integer | required | |
github.event.issue.performed_via_github_app.owner.login | string | required | |
github.event.issue.performed_via_github_app.owner.name | string | optional | |
github.event.issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app.owner.url | string | optional | |
github.event.issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_projects | read , write , admin | optional | |
github.event.issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.issue.performed_via_github_app.updated_at | string or null | required | |
github.event.issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.issue.user.type | Bot , User , Organization , Mannequin | optional |
unlabeled
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | unlabeled | required | |
github.event.issue.assignee.avatar_url | string | optional | |
github.event.issue.assignee.deleted | boolean | optional | |
github.event.issue.assignee.email | string or null | optional | |
github.event.issue.assignee.events_url | string | optional | |
github.event.issue.assignee.followers_url | string | optional | |
github.event.issue.assignee.following_url | string | optional | |
github.event.issue.assignee.gists_url | string | optional | |
github.event.issue.assignee.gravatar_id | string | optional | |
github.event.issue.assignee.html_url | string | optional | |
github.event.issue.assignee.id | integer | required | |
github.event.issue.assignee.login | string | required | |
github.event.issue.assignee.name | string | optional | |
github.event.issue.assignee.node_id | string | optional | |
github.event.issue.assignee.organizations_url | string | optional | |
github.event.issue.assignee.received_events_url | string | optional | |
github.event.issue.assignee.repos_url | string | optional | |
github.event.issue.assignee.site_admin | boolean | optional | |
github.event.issue.assignee.starred_url | string | optional | |
github.event.issue.assignee.subscriptions_url | string | optional | |
github.event.issue.assignee.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.assignee.url | string | optional | |
github.event.issue.labels | array of objects | optional | |
github.event.issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.issue.labels.default | boolean | required | |
github.event.issue.labels.description | string or null | required | |
github.event.issue.labels.id | integer | required | |
github.event.issue.labels.name | string | required | The name of the label. |
github.event.issue.labels.node_id | string | required | |
github.event.issue.labels.url | string | required | URL for the label |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization , Mannequin | optional | |
github.event.issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.issue.performed_via_github_app.created_at | string or null | required | |
github.event.issue.performed_via_github_app.description | string or null | required | |
github.event.issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.issue.performed_via_github_app.external_url | string or null | required | |
github.event.issue.performed_via_github_app.html_url | string | required | |
github.event.issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.issue.performed_via_github_app.node_id | string | required | |
github.event.issue.performed_via_github_app.owner | object or null | required | |
github.event.issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.issue.performed_via_github_app.owner.id | integer | required | |
github.event.issue.performed_via_github_app.owner.login | string | required | |
github.event.issue.performed_via_github_app.owner.name | string | optional | |
github.event.issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app.owner.url | string | optional | |
github.event.issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_projects | read , write , admin | optional | |
github.event.issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.issue.performed_via_github_app.updated_at | string or null | required | |
github.event.issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.issue.user.type | Bot , User , Organization , Mannequin | optional | |
github.event.label | object | optional | |
github.event.label.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.label.default | boolean | required | |
github.event.label.description | string or null | required | |
github.event.label.id | integer | required | |
github.event.label.name | string | required | The name of the label. |
github.event.label.node_id | string | required | |
github.event.label.url | string | required | URL for the label |
unlocked
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | unlocked | required | |
github.event.issue.labels | array of object,nulls | optional | |
github.event.issue.locked | False | required | |
github.event.issue.milestone.creator.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app | null | optional | |
github.event.issue.state | string | optional | |
github.event.issue.user.type | Bot , User , Organization | optional |
unpinned
#
This event occurs when there is activity relating to an issue. For more information about issues, see "About issues." For information about the APIs to manage issues, see the GraphQL documentation or "Issues" in the REST API documentation.
For activity relating to a comment on an issue, use the issue_comment
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
field | type | required | description |
---|---|---|---|
github.event.action | unpinned | required | |
github.event.issue.assignee.avatar_url | string | optional | |
github.event.issue.assignee.deleted | boolean | optional | |
github.event.issue.assignee.email | string or null | optional | |
github.event.issue.assignee.events_url | string | optional | |
github.event.issue.assignee.followers_url | string | optional | |
github.event.issue.assignee.following_url | string | optional | |
github.event.issue.assignee.gists_url | string | optional | |
github.event.issue.assignee.gravatar_id | string | optional | |
github.event.issue.assignee.html_url | string | optional | |
github.event.issue.assignee.id | integer | required | |
github.event.issue.assignee.login | string | required | |
github.event.issue.assignee.name | string | optional | |
github.event.issue.assignee.node_id | string | optional | |
github.event.issue.assignee.organizations_url | string | optional | |
github.event.issue.assignee.received_events_url | string | optional | |
github.event.issue.assignee.repos_url | string | optional | |
github.event.issue.assignee.site_admin | boolean | optional | |
github.event.issue.assignee.starred_url | string | optional | |
github.event.issue.assignee.subscriptions_url | string | optional | |
github.event.issue.assignee.type | Bot , User , Organization | optional | |
github.event.issue.assignee.url | string | optional | |
github.event.issue.labels | array of objects | optional | |
github.event.issue.labels.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.issue.labels.default | boolean | required | |
github.event.issue.labels.description | string or null | required | |
github.event.issue.labels.id | integer | required | |
github.event.issue.labels.name | string | required | The name of the label. |
github.event.issue.labels.node_id | string | required | |
github.event.issue.labels.url | string | required | URL for the label |
github.event.issue.locked | boolean | optional | |
github.event.issue.milestone.creator.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app | object or null | optional | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
github.event.issue.performed_via_github_app.created_at | string or null | required | |
github.event.issue.performed_via_github_app.description | string or null | required | |
github.event.issue.performed_via_github_app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.issue.performed_via_github_app.external_url | string or null | required | |
github.event.issue.performed_via_github_app.html_url | string | required | |
github.event.issue.performed_via_github_app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.issue.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.issue.performed_via_github_app.node_id | string | required | |
github.event.issue.performed_via_github_app.owner | object or null | required | |
github.event.issue.performed_via_github_app.owner.avatar_url | string | optional | |
github.event.issue.performed_via_github_app.owner.deleted | boolean | optional | |
github.event.issue.performed_via_github_app.owner.email | string or null | optional | |
github.event.issue.performed_via_github_app.owner.events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.followers_url | string | optional | |
github.event.issue.performed_via_github_app.owner.following_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gists_url | string | optional | |
github.event.issue.performed_via_github_app.owner.gravatar_id | string | optional | |
github.event.issue.performed_via_github_app.owner.html_url | string | optional | |
github.event.issue.performed_via_github_app.owner.id | integer | required | |
github.event.issue.performed_via_github_app.owner.login | string | required | |
github.event.issue.performed_via_github_app.owner.name | string | optional | |
github.event.issue.performed_via_github_app.owner.node_id | string | optional | |
github.event.issue.performed_via_github_app.owner.organizations_url | string | optional | |
github.event.issue.performed_via_github_app.owner.received_events_url | string | optional | |
github.event.issue.performed_via_github_app.owner.repos_url | string | optional | |
github.event.issue.performed_via_github_app.owner.site_admin | boolean | optional | |
github.event.issue.performed_via_github_app.owner.starred_url | string | optional | |
github.event.issue.performed_via_github_app.owner.subscriptions_url | string | optional | |
github.event.issue.performed_via_github_app.owner.type | Bot , User , Organization | optional | |
github.event.issue.performed_via_github_app.owner.url | string | optional | |
github.event.issue.performed_via_github_app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.issue.performed_via_github_app.permissions.actions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.checks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.content_references | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.contents | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.deployments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.emails | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.environments | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.issues | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.keys | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.members | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.metadata | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_administration | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_plan | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.organization_user_blocking | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.packages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pages | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.pull_requests | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_hooks | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.repository_projects | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.secrets | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_events | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.security_scanning_alert | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.single_file | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.statuses | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.team_discussions | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.vulnerability_alerts | read , write | optional | |
github.event.issue.performed_via_github_app.permissions.workflows | read , write | optional | |
github.event.issue.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.issue.performed_via_github_app.updated_at | string or null | required | |
github.event.issue.state | open , closed | optional | State of the issue; either ‘open’ or ‘closed’ |
github.event.issue.user.type | Bot , User , Organization | optional |