issues

This page was generated based on Github’s Documentation. See our welcome page for context and details.

Github Event issues #

Github Action Trigger #

source

Webhook event payloadActivity typesGITHUB_SHAGITHUB_REF
issuesopened
edited
deleted
transferred
pinned
unpinned
closed
reopened
assigned
unassigned
labeled
unlabeled
locked
unlocked
milestoned
demilestoned
Last commit on default branchDefault 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 openededited, or milestoned.

on:
  issues:
    types: [opened, edited, milestoned]

Event Payload #

source

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.
fieldtyperequireddescription
github.event.enterpriseobjectoptional

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured on an enterprise account or an organization that’s part of an enterprise account. For more information, see “About enterprise accounts."

github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.issueobjectrequired

The issue itself.

github.event.issue.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.issue.assigneeobject or nulloptional
github.event.issue.assigneesarray of object,nullsrequired
github.event.issue.author_associationCOLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERrequired

How the author is associated with the repository.

github.event.issue.bodystring or nullrequired

Contents of the issue

github.event.issue.closed_atstring or nullrequired
github.event.issue.commentsintegerrequired
github.event.issue.comments_urlstringrequired
github.event.issue.created_atstringrequired
github.event.issue.draftbooleanoptional
github.event.issue.events_urlstringrequired
github.event.issue.html_urlstringrequired
github.event.issue.idintegerrequired
github.event.issue.labels_urlstringrequired
github.event.issue.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.issue.milestone.closed_atstring or nullrequired
github.event.issue.milestone.closed_issuesintegerrequired
github.event.issue.milestone.created_atstringrequired
github.event.issue.milestone.creatorobject or nullrequired
github.event.issue.milestone.creator.avatar_urlstringoptional
github.event.issue.milestone.creator.deletedbooleanoptional
github.event.issue.milestone.creator.emailstring or nulloptional
github.event.issue.milestone.creator.events_urlstringoptional
github.event.issue.milestone.creator.followers_urlstringoptional
github.event.issue.milestone.creator.following_urlstringoptional
github.event.issue.milestone.creator.gists_urlstringoptional
github.event.issue.milestone.creator.gravatar_idstringoptional
github.event.issue.milestone.creator.html_urlstringoptional
github.event.issue.milestone.creator.idintegerrequired
github.event.issue.milestone.creator.loginstringrequired
github.event.issue.milestone.creator.namestringoptional
github.event.issue.milestone.creator.node_idstringoptional
github.event.issue.milestone.creator.organizations_urlstringoptional
github.event.issue.milestone.creator.received_events_urlstringoptional
github.event.issue.milestone.creator.repos_urlstringoptional
github.event.issue.milestone.creator.site_adminbooleanoptional
github.event.issue.milestone.creator.starred_urlstringoptional
github.event.issue.milestone.creator.subscriptions_urlstringoptional
github.event.issue.milestone.creator.urlstringoptional
github.event.issue.milestone.descriptionstring or nullrequired
github.event.issue.milestone.due_onstring or nullrequired
github.event.issue.milestone.html_urlstringrequired
github.event.issue.milestone.idintegerrequired
github.event.issue.milestone.labels_urlstringrequired
github.event.issue.milestone.node_idstringrequired
github.event.issue.milestone.numberintegerrequired

The number of the milestone.

github.event.issue.milestone.open_issuesintegerrequired
github.event.issue.milestone.stateopen, closedrequired

The state of the milestone.

github.event.issue.milestone.titlestringrequired

The title of the milestone.

github.event.issue.milestone.updated_atstringrequired
github.event.issue.milestone.urlstringrequired
github.event.issue.node_idstringrequired
github.event.issue.numberintegerrequired
github.event.issue.pull_requestobjectoptional
github.event.issue.pull_request.diff_urlstringoptional
github.event.issue.pull_request.html_urlstringoptional
github.event.issue.pull_request.merged_atstring or nulloptional
github.event.issue.pull_request.patch_urlstringoptional
github.event.issue.pull_request.urlstringoptional
github.event.issue.reactionsobjectrequired
github.event.issue.reactions.+1integerrequired
github.event.issue.reactions.-1integerrequired
github.event.issue.reactions.confusedintegerrequired
github.event.issue.reactions.eyesintegerrequired
github.event.issue.reactions.heartintegerrequired
github.event.issue.reactions.hoorayintegerrequired
github.event.issue.reactions.laughintegerrequired
github.event.issue.reactions.rocketintegerrequired
github.event.issue.reactions.total_countintegerrequired
github.event.issue.reactions.urlstringrequired
github.event.issue.repository_urlstringrequired
github.event.issue.state_reasonstring or nulloptional
github.event.issue.timeline_urlstringoptional
github.event.issue.titlestringrequired

Title of the issue

github.event.issue.updated_atstringrequired
github.event.issue.urlstringrequired

URL for the issue

github.event.issue.userobject or nullrequired
github.event.issue.user.avatar_urlstringoptional
github.event.issue.user.deletedbooleanoptional
github.event.issue.user.emailstring or nulloptional
github.event.issue.user.events_urlstringoptional
github.event.issue.user.followers_urlstringoptional
github.event.issue.user.following_urlstringoptional
github.event.issue.user.gists_urlstringoptional
github.event.issue.user.gravatar_idstringoptional
github.event.issue.user.html_urlstringoptional
github.event.issue.user.idintegerrequired
github.event.issue.user.loginstringrequired
github.event.issue.user.namestringoptional
github.event.issue.user.node_idstringoptional
github.event.issue.user.organizations_urlstringoptional
github.event.issue.user.received_events_urlstringoptional
github.event.issue.user.repos_urlstringoptional
github.event.issue.user.site_adminbooleanoptional
github.event.issue.user.starred_urlstringoptional
github.event.issue.user.subscriptions_urlstringoptional
github.event.issue.user.urlstringoptional
github.event.organizationobjectoptional

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.

github.event.repositoryobjectrequired

The repository on GitHub where the event occurred. Webhook payloads contain the repository property when the event occurs from activity in a repository.

github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionassignedrequired

The action that was performed.

github.event.assigneeobject or nulloptional
github.event.assignee.avatar_urlstringoptional
github.event.assignee.deletedbooleanoptional
github.event.assignee.emailstring or nulloptional
github.event.assignee.events_urlstringoptional
github.event.assignee.followers_urlstringoptional
github.event.assignee.following_urlstringoptional
github.event.assignee.gists_urlstringoptional
github.event.assignee.gravatar_idstringoptional
github.event.assignee.html_urlstringoptional
github.event.assignee.idintegerrequired
github.event.assignee.loginstringrequired
github.event.assignee.namestringoptional
github.event.assignee.node_idstringoptional
github.event.assignee.organizations_urlstringoptional
github.event.assignee.received_events_urlstringoptional
github.event.assignee.repos_urlstringoptional
github.event.assignee.site_adminbooleanoptional
github.event.assignee.starred_urlstringoptional
github.event.assignee.subscriptions_urlstringoptional
github.event.assignee.typeBot, User, Organizationoptional
github.event.assignee.urlstringoptional
github.event.issue.assignee.avatar_urlstringoptional
github.event.issue.assignee.deletedbooleanoptional
github.event.issue.assignee.emailstring or nulloptional
github.event.issue.assignee.events_urlstringoptional
github.event.issue.assignee.followers_urlstringoptional
github.event.issue.assignee.following_urlstringoptional
github.event.issue.assignee.gists_urlstringoptional
github.event.issue.assignee.gravatar_idstringoptional
github.event.issue.assignee.html_urlstringoptional
github.event.issue.assignee.idintegerrequired
github.event.issue.assignee.loginstringrequired
github.event.issue.assignee.namestringoptional
github.event.issue.assignee.node_idstringoptional
github.event.issue.assignee.organizations_urlstringoptional
github.event.issue.assignee.received_events_urlstringoptional
github.event.issue.assignee.repos_urlstringoptional
github.event.issue.assignee.site_adminbooleanoptional
github.event.issue.assignee.starred_urlstringoptional
github.event.issue.assignee.subscriptions_urlstringoptional
github.event.issue.assignee.typeBot, User, Organization, Mannequinoptional
github.event.issue.assignee.urlstringoptional
github.event.issue.labelsarray of objectsoptional
github.event.issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.issue.labels.defaultbooleanrequired
github.event.issue.labels.descriptionstring or nullrequired
github.event.issue.labels.idintegerrequired
github.event.issue.labels.namestringrequired

The name of the label.

github.event.issue.labels.node_idstringrequired
github.event.issue.labels.urlstringrequired

URL for the label

github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.issue.performed_via_github_app.descriptionstring or nullrequired
github.event.issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

github.event.issue.performed_via_github_app.external_urlstring or nullrequired
github.event.issue.performed_via_github_app.html_urlstringrequired
github.event.issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.issue.performed_via_github_app.node_idstringrequired
github.event.issue.performed_via_github_app.ownerobject or nullrequired
github.event.issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.issue.performed_via_github_app.owner.events_urlstringoptional
github.event.issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.issue.performed_via_github_app.owner.following_urlstringoptional
github.event.issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.issue.performed_via_github_app.owner.html_urlstringoptional
github.event.issue.performed_via_github_app.owner.idintegerrequired
github.event.issue.performed_via_github_app.owner.loginstringrequired
github.event.issue.performed_via_github_app.owner.namestringoptional
github.event.issue.performed_via_github_app.owner.node_idstringoptional
github.event.issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_app.owner.urlstringoptional
github.event.issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_projectsread, write, adminoptional
github.event.issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.issue.performed_via_github_app.updated_atstring or nullrequired
github.event.issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.issue.user.typeBot, User, Organization, Mannequinoptional

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.

fieldtyperequireddescription
github.event.actionclosedrequired

The action that was performed.

github.event.issue.labelsarray of object,nullsoptional
github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.issue.performed_via_github_appobject or nulloptional
github.event.issue.stateclosed, openrequired
github.event.issue.user.typeBot, User, Organization, Mannequinoptional

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.

fieldtyperequireddescription
github.event.actiondeletedrequired
github.event.issue.assignee.avatar_urlstringoptional
github.event.issue.assignee.deletedbooleanoptional
github.event.issue.assignee.emailstring or nulloptional
github.event.issue.assignee.events_urlstringoptional
github.event.issue.assignee.followers_urlstringoptional
github.event.issue.assignee.following_urlstringoptional
github.event.issue.assignee.gists_urlstringoptional
github.event.issue.assignee.gravatar_idstringoptional
github.event.issue.assignee.html_urlstringoptional
github.event.issue.assignee.idintegerrequired
github.event.issue.assignee.loginstringrequired
github.event.issue.assignee.namestringoptional
github.event.issue.assignee.node_idstringoptional
github.event.issue.assignee.organizations_urlstringoptional
github.event.issue.assignee.received_events_urlstringoptional
github.event.issue.assignee.repos_urlstringoptional
github.event.issue.assignee.site_adminbooleanoptional
github.event.issue.assignee.starred_urlstringoptional
github.event.issue.assignee.subscriptions_urlstringoptional
github.event.issue.assignee.typeBot, User, Organizationoptional
github.event.issue.assignee.urlstringoptional
github.event.issue.labelsarray of objectsoptional
github.event.issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.issue.labels.defaultbooleanrequired
github.event.issue.labels.descriptionstring or nullrequired
github.event.issue.labels.idintegerrequired
github.event.issue.labels.namestringrequired

The name of the label.

github.event.issue.labels.node_idstringrequired
github.event.issue.labels.urlstringrequired

URL for the label

github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.issue.performed_via_github_app.descriptionstring or nullrequired
github.event.issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder

github.event.issue.performed_via_github_app.external_urlstring or nullrequired
github.event.issue.performed_via_github_app.html_urlstringrequired
github.event.issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.issue.performed_via_github_app.node_idstringrequired
github.event.issue.performed_via_github_app.ownerobject or nullrequired
github.event.issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.issue.performed_via_github_app.owner.events_urlstringoptional
github.event.issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.issue.performed_via_github_app.owner.following_urlstringoptional
github.event.issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.issue.performed_via_github_app.owner.html_urlstringoptional
github.event.issue.performed_via_github_app.owner.idintegerrequired
github.event.issue.performed_via_github_app.owner.loginstringrequired
github.event.issue.performed_via_github_app.owner.namestringoptional
github.event.issue.performed_via_github_app.owner.node_idstringoptional
github.event.issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_app.owner.urlstringoptional
github.event.issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.issue.performed_via_github_app.updated_atstring or nullrequired
github.event.issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.issue.user.typeBot, User, Organizationoptional

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.

fieldtyperequireddescription
github.event.actiondemilestonedrequired
github.event.issue.labelsarray of object,nullsoptional
github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.issue.performed_via_github_appobject or nulloptional
github.event.issue.statestringoptional
github.event.issue.user.typeBot, User, Organization, Mannequinoptional
github.event.milestoneobjectoptional

A collection of related issues and pull requests.

github.event.milestone.closed_atstring or nullrequired
github.event.milestone.closed_issuesintegerrequired
github.event.milestone.created_atstringrequired
github.event.milestone.creatorobject or nullrequired
github.event.milestone.creator.avatar_urlstringoptional
github.event.milestone.creator.deletedbooleanoptional
github.event.milestone.creator.emailstring or nulloptional
github.event.milestone.creator.events_urlstringoptional
github.event.milestone.creator.followers_urlstringoptional
github.event.milestone.creator.following_urlstringoptional
github.event.milestone.creator.gists_urlstringoptional
github.event.milestone.creator.gravatar_idstringoptional
github.event.milestone.creator.html_urlstringoptional
github.event.milestone.creator.idintegerrequired
github.event.milestone.creator.loginstringrequired
github.event.milestone.creator.namestringoptional
github.event.milestone.creator.node_idstringoptional
github.event.milestone.creator.organizations_urlstringoptional
github.event.milestone.creator.received_events_urlstringoptional
github.event.milestone.creator.repos_urlstringoptional
github.event.milestone.creator.site_adminbooleanoptional
github.event.milestone.creator.starred_urlstringoptional
github.event.milestone.creator.subscriptions_urlstringoptional
github.event.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.milestone.creator.urlstringoptional
github.event.milestone.descriptionstring or nullrequired
github.event.milestone.due_onstring or nullrequired
github.event.milestone.html_urlstringrequired
github.event.milestone.idintegerrequired
github.event.milestone.labels_urlstringrequired
github.event.milestone.node_idstringrequired
github.event.milestone.numberintegerrequired

The number of the milestone.

github.event.milestone.open_issuesintegerrequired
github.event.milestone.stateopen, closedrequired

The state of the milestone.

github.event.milestone.titlestringrequired

The title of the milestone.

github.event.milestone.updated_atstringrequired
github.event.milestone.urlstringrequired

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.

fieldtyperequireddescription
github.event.actioneditedrequired
github.event.changesobjectrequired

The changes to the issue.

github.event.changes.bodyobjectoptional
github.event.changes.body.fromstringrequired

The previous version of the body.

github.event.changes.titleobjectoptional
github.event.changes.title.fromstringrequired

The previous version of the title.

github.event.issue.assignee.avatar_urlstringoptional
github.event.issue.assignee.deletedbooleanoptional
github.event.issue.assignee.emailstring or nulloptional
github.event.issue.assignee.events_urlstringoptional
github.event.issue.assignee.followers_urlstringoptional
github.event.issue.assignee.following_urlstringoptional
github.event.issue.assignee.gists_urlstringoptional
github.event.issue.assignee.gravatar_idstringoptional
github.event.issue.assignee.html_urlstringoptional
github.event.issue.assignee.idintegerrequired
github.event.issue.assignee.loginstringrequired
github.event.issue.assignee.namestringoptional
github.event.issue.assignee.node_idstringoptional
github.event.issue.assignee.organizations_urlstringoptional
github.event.issue.assignee.received_events_urlstringoptional
github.event.issue.assignee.repos_urlstringoptional
github.event.issue.assignee.site_adminbooleanoptional
github.event.issue.assignee.starred_urlstringoptional
github.event.issue.assignee.subscriptions_urlstringoptional
github.event.issue.assignee.typeBot, User, Organization, Mannequinoptional
github.event.issue.assignee.urlstringoptional
github.event.issue.labelsarray of objectsoptional
github.event.issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.issue.labels.defaultbooleanrequired
github.event.issue.labels.descriptionstring or nullrequired
github.event.issue.labels.idintegerrequired
github.event.issue.labels.namestringrequired

The name of the label.

github.event.issue.labels.node_idstringrequired
github.event.issue.labels.urlstringrequired

URL for the label

github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.issue.performed_via_github_app.descriptionstring or nullrequired
github.event.issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, security_and_analysis, pull_request_review_thread, reminder

github.event.issue.performed_via_github_app.external_urlstring or nullrequired
github.event.issue.performed_via_github_app.html_urlstringrequired
github.event.issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.issue.performed_via_github_app.node_idstringrequired
github.event.issue.performed_via_github_app.ownerobject or nullrequired
github.event.issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.issue.performed_via_github_app.owner.events_urlstringoptional
github.event.issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.issue.performed_via_github_app.owner.following_urlstringoptional
github.event.issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.issue.performed_via_github_app.owner.html_urlstringoptional
github.event.issue.performed_via_github_app.owner.idintegerrequired
github.event.issue.performed_via_github_app.owner.loginstringrequired
github.event.issue.performed_via_github_app.owner.namestringoptional
github.event.issue.performed_via_github_app.owner.node_idstringoptional
github.event.issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_app.owner.urlstringoptional
github.event.issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_projectsread, write, adminoptional
github.event.issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.issue.performed_via_github_app.updated_atstring or nullrequired
github.event.issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.issue.user.typeBot, User, Organization, Mannequinoptional
github.event.labelobjectoptional
github.event.label.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.label.defaultbooleanrequired
github.event.label.descriptionstring or nullrequired
github.event.label.idintegerrequired
github.event.label.namestringrequired

The name of the label.

github.event.label.node_idstringrequired
github.event.label.urlstringrequired

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.

fieldtyperequireddescription
github.event.actionlabeledrequired
github.event.issue.assignee.avatar_urlstringoptional
github.event.issue.assignee.deletedbooleanoptional
github.event.issue.assignee.emailstring or nulloptional
github.event.issue.assignee.events_urlstringoptional
github.event.issue.assignee.followers_urlstringoptional
github.event.issue.assignee.following_urlstringoptional
github.event.issue.assignee.gists_urlstringoptional
github.event.issue.assignee.gravatar_idstringoptional
github.event.issue.assignee.html_urlstringoptional
github.event.issue.assignee.idintegerrequired
github.event.issue.assignee.loginstringrequired
github.event.issue.assignee.namestringoptional
github.event.issue.assignee.node_idstringoptional
github.event.issue.assignee.organizations_urlstringoptional
github.event.issue.assignee.received_events_urlstringoptional
github.event.issue.assignee.repos_urlstringoptional
github.event.issue.assignee.site_adminbooleanoptional
github.event.issue.assignee.starred_urlstringoptional
github.event.issue.assignee.subscriptions_urlstringoptional
github.event.issue.assignee.typeBot, User, Organization, Mannequinoptional
github.event.issue.assignee.urlstringoptional
github.event.issue.labelsarray of objectsoptional
github.event.issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.issue.labels.defaultbooleanrequired
github.event.issue.labels.descriptionstring or nullrequired
github.event.issue.labels.idintegerrequired
github.event.issue.labels.namestringrequired

The name of the label.

github.event.issue.labels.node_idstringrequired
github.event.issue.labels.urlstringrequired

URL for the label

github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.issue.performed_via_github_app.descriptionstring or nullrequired
github.event.issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, pull_request_review_thread, reminder

github.event.issue.performed_via_github_app.external_urlstring or nullrequired
github.event.issue.performed_via_github_app.html_urlstringrequired
github.event.issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.issue.performed_via_github_app.node_idstringrequired
github.event.issue.performed_via_github_app.ownerobject or nullrequired
github.event.issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.issue.performed_via_github_app.owner.events_urlstringoptional
github.event.issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.issue.performed_via_github_app.owner.following_urlstringoptional
github.event.issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.issue.performed_via_github_app.owner.html_urlstringoptional
github.event.issue.performed_via_github_app.owner.idintegerrequired
github.event.issue.performed_via_github_app.owner.loginstringrequired
github.event.issue.performed_via_github_app.owner.namestringoptional
github.event.issue.performed_via_github_app.owner.node_idstringoptional
github.event.issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_app.owner.urlstringoptional
github.event.issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_projectsread, write, adminoptional
github.event.issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.issue.performed_via_github_app.updated_atstring or nullrequired
github.event.issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.issue.user.typeBot, User, Organization, Mannequinoptional
github.event.labelobjectoptional
github.event.label.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.label.defaultbooleanrequired
github.event.label.descriptionstring or nullrequired
github.event.label.idintegerrequired
github.event.label.namestringrequired

The name of the label.

github.event.label.node_idstringrequired
github.event.label.urlstringrequired

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.

fieldtyperequireddescription
github.event.actionlockedrequired
github.event.issue.labelsarray of object,nullsoptional
github.event.issue.lockedTruerequired
github.event.issue.milestone.creator.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_appobject or nulloptional
github.event.issue.statestringoptional
github.event.issue.user.typeBot, User, Organizationoptional

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.

fieldtyperequireddescription
github.event.actionmilestonedrequired
github.event.issue.labelsarray of object,nullsoptional
github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.issue.performed_via_github_appobject or nulloptional
github.event.issue.statestringoptional
github.event.issue.user.typeBot, User, Organizationoptional
github.event.milestoneobjectrequired

A collection of related issues and pull requests.

github.event.milestone.closed_atstring or nullrequired
github.event.milestone.closed_issuesintegerrequired
github.event.milestone.created_atstringrequired
github.event.milestone.creatorobject or nullrequired
github.event.milestone.creator.avatar_urlstringoptional
github.event.milestone.creator.deletedbooleanoptional
github.event.milestone.creator.emailstring or nulloptional
github.event.milestone.creator.events_urlstringoptional
github.event.milestone.creator.followers_urlstringoptional
github.event.milestone.creator.following_urlstringoptional
github.event.milestone.creator.gists_urlstringoptional
github.event.milestone.creator.gravatar_idstringoptional
github.event.milestone.creator.html_urlstringoptional
github.event.milestone.creator.idintegerrequired
github.event.milestone.creator.loginstringrequired
github.event.milestone.creator.namestringoptional
github.event.milestone.creator.node_idstringoptional
github.event.milestone.creator.organizations_urlstringoptional
github.event.milestone.creator.received_events_urlstringoptional
github.event.milestone.creator.repos_urlstringoptional
github.event.milestone.creator.site_adminbooleanoptional
github.event.milestone.creator.starred_urlstringoptional
github.event.milestone.creator.subscriptions_urlstringoptional
github.event.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.milestone.creator.urlstringoptional
github.event.milestone.descriptionstring or nullrequired
github.event.milestone.due_onstring or nullrequired
github.event.milestone.html_urlstringrequired
github.event.milestone.idintegerrequired
github.event.milestone.labels_urlstringrequired
github.event.milestone.node_idstringrequired
github.event.milestone.numberintegerrequired

The number of the milestone.

github.event.milestone.open_issuesintegerrequired
github.event.milestone.stateopen, closedrequired

The state of the milestone.

github.event.milestone.titlestringrequired

The title of the milestone.

github.event.milestone.updated_atstringrequired
github.event.milestone.urlstringrequired

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.

fieldtyperequireddescription
github.event.actionopenedrequired
github.event.changesobjectoptional
github.event.changes.old_issueobject or nullrequired

The issue itself.

github.event.changes.old_issue.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.changes.old_issue.assigneeobject or nulloptional
github.event.changes.old_issue.assignee.avatar_urlstringoptional
github.event.changes.old_issue.assignee.deletedbooleanoptional
github.event.changes.old_issue.assignee.emailstring or nulloptional
github.event.changes.old_issue.assignee.events_urlstringoptional
github.event.changes.old_issue.assignee.followers_urlstringoptional
github.event.changes.old_issue.assignee.following_urlstringoptional
github.event.changes.old_issue.assignee.gists_urlstringoptional
github.event.changes.old_issue.assignee.gravatar_idstringoptional
github.event.changes.old_issue.assignee.html_urlstringoptional
github.event.changes.old_issue.assignee.idintegerrequired
github.event.changes.old_issue.assignee.loginstringrequired
github.event.changes.old_issue.assignee.namestringoptional
github.event.changes.old_issue.assignee.node_idstringoptional
github.event.changes.old_issue.assignee.organizations_urlstringoptional
github.event.changes.old_issue.assignee.received_events_urlstringoptional
github.event.changes.old_issue.assignee.repos_urlstringoptional
github.event.changes.old_issue.assignee.site_adminbooleanoptional
github.event.changes.old_issue.assignee.starred_urlstringoptional
github.event.changes.old_issue.assignee.subscriptions_urlstringoptional
github.event.changes.old_issue.assignee.typeBot, User, Organizationoptional
github.event.changes.old_issue.assignee.urlstringoptional
github.event.changes.old_issue.assigneesarray of object,nullsrequired
github.event.changes.old_issue.author_associationCOLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERrequired

How the author is associated with the repository.

github.event.changes.old_issue.bodystring or nullrequired

Contents of the issue

github.event.changes.old_issue.closed_atstring or nullrequired
github.event.changes.old_issue.commentsintegerrequired
github.event.changes.old_issue.comments_urlstringrequired
github.event.changes.old_issue.created_atstringrequired
github.event.changes.old_issue.draftbooleanoptional
github.event.changes.old_issue.events_urlstringrequired
github.event.changes.old_issue.html_urlstringrequired
github.event.changes.old_issue.idintegerrequired
github.event.changes.old_issue.labelsarray of objectsoptional
github.event.changes.old_issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.changes.old_issue.labels.defaultbooleanrequired
github.event.changes.old_issue.labels.descriptionstring or nullrequired
github.event.changes.old_issue.labels.idintegerrequired
github.event.changes.old_issue.labels.namestringrequired

The name of the label.

github.event.changes.old_issue.labels.node_idstringrequired
github.event.changes.old_issue.labels.urlstringrequired

URL for the label

github.event.changes.old_issue.labels_urlstringrequired
github.event.changes.old_issue.lockedbooleanoptional
github.event.changes.old_issue.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.changes.old_issue.milestone.closed_atstring or nullrequired
github.event.changes.old_issue.milestone.closed_issuesintegerrequired
github.event.changes.old_issue.milestone.created_atstringrequired
github.event.changes.old_issue.milestone.creatorobject or nullrequired
github.event.changes.old_issue.milestone.creator.avatar_urlstringoptional
github.event.changes.old_issue.milestone.creator.deletedbooleanoptional
github.event.changes.old_issue.milestone.creator.emailstring or nulloptional
github.event.changes.old_issue.milestone.creator.events_urlstringoptional
github.event.changes.old_issue.milestone.creator.followers_urlstringoptional
github.event.changes.old_issue.milestone.creator.following_urlstringoptional
github.event.changes.old_issue.milestone.creator.gists_urlstringoptional
github.event.changes.old_issue.milestone.creator.gravatar_idstringoptional
github.event.changes.old_issue.milestone.creator.html_urlstringoptional
github.event.changes.old_issue.milestone.creator.idintegerrequired
github.event.changes.old_issue.milestone.creator.loginstringrequired
github.event.changes.old_issue.milestone.creator.namestringoptional
github.event.changes.old_issue.milestone.creator.node_idstringoptional
github.event.changes.old_issue.milestone.creator.organizations_urlstringoptional
github.event.changes.old_issue.milestone.creator.received_events_urlstringoptional
github.event.changes.old_issue.milestone.creator.repos_urlstringoptional
github.event.changes.old_issue.milestone.creator.site_adminbooleanoptional
github.event.changes.old_issue.milestone.creator.starred_urlstringoptional
github.event.changes.old_issue.milestone.creator.subscriptions_urlstringoptional
github.event.changes.old_issue.milestone.creator.typeBot, User, Organizationoptional
github.event.changes.old_issue.milestone.creator.urlstringoptional
github.event.changes.old_issue.milestone.descriptionstring or nullrequired
github.event.changes.old_issue.milestone.due_onstring or nullrequired
github.event.changes.old_issue.milestone.html_urlstringrequired
github.event.changes.old_issue.milestone.idintegerrequired
github.event.changes.old_issue.milestone.labels_urlstringrequired
github.event.changes.old_issue.milestone.node_idstringrequired
github.event.changes.old_issue.milestone.numberintegerrequired

The number of the milestone.

github.event.changes.old_issue.milestone.open_issuesintegerrequired
github.event.changes.old_issue.milestone.stateopen, closedrequired

The state of the milestone.

github.event.changes.old_issue.milestone.titlestringrequired

The title of the milestone.

github.event.changes.old_issue.milestone.updated_atstringrequired
github.event.changes.old_issue.milestone.urlstringrequired
github.event.changes.old_issue.node_idstringrequired
github.event.changes.old_issue.numberintegerrequired
github.event.changes.old_issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.changes.old_issue.performed_via_github_app.descriptionstring or nullrequired
github.event.changes.old_issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

github.event.changes.old_issue.performed_via_github_app.external_urlstring or nullrequired
github.event.changes.old_issue.performed_via_github_app.html_urlstringrequired
github.event.changes.old_issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.changes.old_issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.changes.old_issue.performed_via_github_app.node_idstringrequired
github.event.changes.old_issue.performed_via_github_app.ownerobject or nullrequired
github.event.changes.old_issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.changes.old_issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.changes.old_issue.performed_via_github_app.owner.events_urlstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.following_urlstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.html_urlstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.idintegerrequired
github.event.changes.old_issue.performed_via_github_app.owner.loginstringrequired
github.event.changes.old_issue.performed_via_github_app.owner.namestringoptional
github.event.changes.old_issue.performed_via_github_app.owner.node_idstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.changes.old_issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.changes.old_issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.changes.old_issue.performed_via_github_app.owner.urlstringoptional
github.event.changes.old_issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.changes.old_issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.organization_projectsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.changes.old_issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.changes.old_issue.performed_via_github_app.updated_atstring or nullrequired
github.event.changes.old_issue.pull_requestobjectoptional
github.event.changes.old_issue.pull_request.diff_urlstringoptional
github.event.changes.old_issue.pull_request.html_urlstringoptional
github.event.changes.old_issue.pull_request.merged_atstring or nulloptional
github.event.changes.old_issue.pull_request.patch_urlstringoptional
github.event.changes.old_issue.pull_request.urlstringoptional
github.event.changes.old_issue.reactionsobjectrequired
github.event.changes.old_issue.reactions.+1integerrequired
github.event.changes.old_issue.reactions.-1integerrequired
github.event.changes.old_issue.reactions.confusedintegerrequired
github.event.changes.old_issue.reactions.eyesintegerrequired
github.event.changes.old_issue.reactions.heartintegerrequired
github.event.changes.old_issue.reactions.hoorayintegerrequired
github.event.changes.old_issue.reactions.laughintegerrequired
github.event.changes.old_issue.reactions.rocketintegerrequired
github.event.changes.old_issue.reactions.total_countintegerrequired
github.event.changes.old_issue.reactions.urlstringrequired
github.event.changes.old_issue.repository_urlstringrequired
github.event.changes.old_issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.changes.old_issue.state_reasonstring or nulloptional
github.event.changes.old_issue.timeline_urlstringoptional
github.event.changes.old_issue.titlestringrequired

Title of the issue

github.event.changes.old_issue.updated_atstringrequired
github.event.changes.old_issue.urlstringrequired

URL for the issue

github.event.changes.old_issue.userobject or nullrequired
github.event.changes.old_issue.user.avatar_urlstringoptional
github.event.changes.old_issue.user.deletedbooleanoptional
github.event.changes.old_issue.user.emailstring or nulloptional
github.event.changes.old_issue.user.events_urlstringoptional
github.event.changes.old_issue.user.followers_urlstringoptional
github.event.changes.old_issue.user.following_urlstringoptional
github.event.changes.old_issue.user.gists_urlstringoptional
github.event.changes.old_issue.user.gravatar_idstringoptional
github.event.changes.old_issue.user.html_urlstringoptional
github.event.changes.old_issue.user.idintegerrequired
github.event.changes.old_issue.user.loginstringrequired
github.event.changes.old_issue.user.namestringoptional
github.event.changes.old_issue.user.node_idstringoptional
github.event.changes.old_issue.user.organizations_urlstringoptional
github.event.changes.old_issue.user.received_events_urlstringoptional
github.event.changes.old_issue.user.repos_urlstringoptional
github.event.changes.old_issue.user.site_adminbooleanoptional
github.event.changes.old_issue.user.starred_urlstringoptional
github.event.changes.old_issue.user.subscriptions_urlstringoptional
github.event.changes.old_issue.user.typeBot, User, Organizationoptional
github.event.changes.old_issue.user.urlstringoptional
github.event.changes.old_repositoryobjectrequired

A git repository

github.event.changes.old_repository.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.changes.old_repository.allow_forkingbooleanoptional

Whether to allow private forks

github.event.changes.old_repository.allow_merge_commitbooleanoptional

Whether to allow merge commits for pull requests.

github.event.changes.old_repository.allow_rebase_mergebooleanoptional

Whether to allow rebase merges for pull requests.

github.event.changes.old_repository.allow_squash_mergebooleanoptional

Whether to allow squash merges for pull requests.

github.event.changes.old_repository.allow_update_branchbooleanoptional
github.event.changes.old_repository.archive_urlstringrequired
github.event.changes.old_repository.archivedbooleanrequired

Whether the repository is archived.

github.event.changes.old_repository.assignees_urlstringrequired
github.event.changes.old_repository.blobs_urlstringrequired
github.event.changes.old_repository.branches_urlstringrequired
github.event.changes.old_repository.clone_urlstringrequired
github.event.changes.old_repository.collaborators_urlstringrequired
github.event.changes.old_repository.comments_urlstringrequired
github.event.changes.old_repository.commits_urlstringrequired
github.event.changes.old_repository.compare_urlstringrequired
github.event.changes.old_repository.contents_urlstringrequired
github.event.changes.old_repository.contributors_urlstringrequired
github.event.changes.old_repository.created_atinteger or stringrequired
github.event.changes.old_repository.custom_propertiesobjectoptional

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_branchstringrequired

The default branch of the repository.

github.event.changes.old_repository.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.changes.old_repository.deployments_urlstringrequired
github.event.changes.old_repository.descriptionstring or nullrequired
github.event.changes.old_repository.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.changes.old_repository.downloads_urlstringrequired
github.event.changes.old_repository.events_urlstringrequired
github.event.changes.old_repository.forkbooleanrequired
github.event.changes.old_repository.forksintegerrequired
github.event.changes.old_repository.forks_countintegerrequired
github.event.changes.old_repository.forks_urlstringrequired
github.event.changes.old_repository.full_namestringrequired
github.event.changes.old_repository.git_commits_urlstringrequired
github.event.changes.old_repository.git_refs_urlstringrequired
github.event.changes.old_repository.git_tags_urlstringrequired
github.event.changes.old_repository.git_urlstringrequired
github.event.changes.old_repository.has_discussionsbooleanoptional

Whether the repository has discussions enabled.

github.event.changes.old_repository.has_downloadsbooleanrequired

Whether downloads are enabled.

github.event.changes.old_repository.has_issuesbooleanrequired

Whether issues are enabled.

github.event.changes.old_repository.has_pagesbooleanrequired
github.event.changes.old_repository.has_projectsbooleanrequired

Whether projects are enabled.

github.event.changes.old_repository.has_wikibooleanrequired

Whether the wiki is enabled.

github.event.changes.old_repository.homepagestring or nullrequired
github.event.changes.old_repository.hooks_urlstringrequired
github.event.changes.old_repository.html_urlstringrequired
github.event.changes.old_repository.idintegerrequired

Unique identifier of the repository

github.event.changes.old_repository.is_templatebooleanoptional
github.event.changes.old_repository.issue_comment_urlstringrequired
github.event.changes.old_repository.issue_events_urlstringrequired
github.event.changes.old_repository.issues_urlstringrequired
github.event.changes.old_repository.keys_urlstringrequired
github.event.changes.old_repository.labels_urlstringrequired
github.event.changes.old_repository.languagestring or nullrequired
github.event.changes.old_repository.languages_urlstringrequired
github.event.changes.old_repository.licenseobject or nullrequired
github.event.changes.old_repository.license.keystringrequired
github.event.changes.old_repository.license.namestringrequired
github.event.changes.old_repository.license.node_idstringrequired
github.event.changes.old_repository.license.spdx_idstringrequired
github.event.changes.old_repository.license.urlstring or nullrequired
github.event.changes.old_repository.master_branchstringoptional
github.event.changes.old_repository.merges_urlstringrequired
github.event.changes.old_repository.milestones_urlstringrequired
github.event.changes.old_repository.mirror_urlstring or nullrequired
github.event.changes.old_repository.namestringrequired

The name of the repository.

github.event.changes.old_repository.node_idstringrequired
github.event.changes.old_repository.notifications_urlstringrequired
github.event.changes.old_repository.open_issuesintegerrequired
github.event.changes.old_repository.open_issues_countintegerrequired
github.event.changes.old_repository.organizationstringoptional
github.event.changes.old_repository.ownerobject or nullrequired
github.event.changes.old_repository.owner.avatar_urlstringoptional
github.event.changes.old_repository.owner.deletedbooleanoptional
github.event.changes.old_repository.owner.emailstring or nulloptional
github.event.changes.old_repository.owner.events_urlstringoptional
github.event.changes.old_repository.owner.followers_urlstringoptional
github.event.changes.old_repository.owner.following_urlstringoptional
github.event.changes.old_repository.owner.gists_urlstringoptional
github.event.changes.old_repository.owner.gravatar_idstringoptional
github.event.changes.old_repository.owner.html_urlstringoptional
github.event.changes.old_repository.owner.idintegerrequired
github.event.changes.old_repository.owner.loginstringrequired
github.event.changes.old_repository.owner.namestringoptional
github.event.changes.old_repository.owner.node_idstringoptional
github.event.changes.old_repository.owner.organizations_urlstringoptional
github.event.changes.old_repository.owner.received_events_urlstringoptional
github.event.changes.old_repository.owner.repos_urlstringoptional
github.event.changes.old_repository.owner.site_adminbooleanoptional
github.event.changes.old_repository.owner.starred_urlstringoptional
github.event.changes.old_repository.owner.subscriptions_urlstringoptional
github.event.changes.old_repository.owner.typeBot, User, Organizationoptional
github.event.changes.old_repository.owner.urlstringoptional
github.event.changes.old_repository.permissionsobjectoptional
github.event.changes.old_repository.permissions.adminbooleanrequired
github.event.changes.old_repository.permissions.maintainbooleanoptional
github.event.changes.old_repository.permissions.pullbooleanrequired
github.event.changes.old_repository.permissions.pushbooleanrequired
github.event.changes.old_repository.permissions.triagebooleanoptional
github.event.changes.old_repository.privatebooleanrequired

Whether the repository is private or public.

github.event.changes.old_repository.publicbooleanoptional
github.event.changes.old_repository.pulls_urlstringrequired
github.event.changes.old_repository.pushed_atnull or integer or stringrequired
github.event.changes.old_repository.releases_urlstringrequired
github.event.changes.old_repository.role_namestring or nulloptional
github.event.changes.old_repository.sizeintegerrequired
github.event.changes.old_repository.ssh_urlstringrequired
github.event.changes.old_repository.stargazersintegeroptional
github.event.changes.old_repository.stargazers_countintegerrequired
github.event.changes.old_repository.stargazers_urlstringrequired
github.event.changes.old_repository.statuses_urlstringrequired
github.event.changes.old_repository.subscribers_urlstringrequired
github.event.changes.old_repository.subscription_urlstringrequired
github.event.changes.old_repository.svn_urlstringrequired
github.event.changes.old_repository.tags_urlstringrequired
github.event.changes.old_repository.teams_urlstringrequired
github.event.changes.old_repository.topicsarray of stringsrequired
github.event.changes.old_repository.trees_urlstringrequired
github.event.changes.old_repository.updated_atstringrequired
github.event.changes.old_repository.urlstringrequired
github.event.changes.old_repository.visibilitypublic, private, internalrequired
github.event.changes.old_repository.watchersintegerrequired
github.event.changes.old_repository.watchers_countintegerrequired
github.event.changes.old_repository.web_commit_signoff_requiredbooleanoptional

Whether to require commit signoff.

github.event.issue.assignee.avatar_urlstringoptional
github.event.issue.assignee.deletedbooleanoptional
github.event.issue.assignee.emailstring or nulloptional
github.event.issue.assignee.events_urlstringoptional
github.event.issue.assignee.followers_urlstringoptional
github.event.issue.assignee.following_urlstringoptional
github.event.issue.assignee.gists_urlstringoptional
github.event.issue.assignee.gravatar_idstringoptional
github.event.issue.assignee.html_urlstringoptional
github.event.issue.assignee.idintegerrequired
github.event.issue.assignee.loginstringrequired
github.event.issue.assignee.namestringoptional
github.event.issue.assignee.node_idstringoptional
github.event.issue.assignee.organizations_urlstringoptional
github.event.issue.assignee.received_events_urlstringoptional
github.event.issue.assignee.repos_urlstringoptional
github.event.issue.assignee.site_adminbooleanoptional
github.event.issue.assignee.starred_urlstringoptional
github.event.issue.assignee.subscriptions_urlstringoptional
github.event.issue.assignee.typeBot, User, Organizationoptional
github.event.issue.assignee.urlstringoptional
github.event.issue.labelsarray of objectsoptional
github.event.issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.issue.labels.defaultbooleanrequired
github.event.issue.labels.descriptionstring or nullrequired
github.event.issue.labels.idintegerrequired
github.event.issue.labels.namestringrequired

The name of the label.

github.event.issue.labels.node_idstringrequired
github.event.issue.labels.urlstringrequired

URL for the label

github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.issue.performed_via_github_app.descriptionstring or nullrequired
github.event.issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, security_and_analysis, pull_request_review_thread, reminder

github.event.issue.performed_via_github_app.external_urlstring or nullrequired
github.event.issue.performed_via_github_app.html_urlstringrequired
github.event.issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.issue.performed_via_github_app.node_idstringrequired
github.event.issue.performed_via_github_app.ownerobject or nullrequired
github.event.issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.issue.performed_via_github_app.owner.events_urlstringoptional
github.event.issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.issue.performed_via_github_app.owner.following_urlstringoptional
github.event.issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.issue.performed_via_github_app.owner.html_urlstringoptional
github.event.issue.performed_via_github_app.owner.idintegerrequired
github.event.issue.performed_via_github_app.owner.loginstringrequired
github.event.issue.performed_via_github_app.owner.namestringoptional
github.event.issue.performed_via_github_app.owner.node_idstringoptional
github.event.issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_app.owner.urlstringoptional
github.event.issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_projectsread, write, adminoptional
github.event.issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.issue.performed_via_github_app.updated_atstring or nullrequired
github.event.issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.issue.user.typeBot, User, Organizationoptional

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.

fieldtyperequireddescription
github.event.actionpinnedrequired
github.event.issue.assignee.avatar_urlstringoptional
github.event.issue.assignee.deletedbooleanoptional
github.event.issue.assignee.emailstring or nulloptional
github.event.issue.assignee.events_urlstringoptional
github.event.issue.assignee.followers_urlstringoptional
github.event.issue.assignee.following_urlstringoptional
github.event.issue.assignee.gists_urlstringoptional
github.event.issue.assignee.gravatar_idstringoptional
github.event.issue.assignee.html_urlstringoptional
github.event.issue.assignee.idintegerrequired
github.event.issue.assignee.loginstringrequired
github.event.issue.assignee.namestringoptional
github.event.issue.assignee.node_idstringoptional
github.event.issue.assignee.organizations_urlstringoptional
github.event.issue.assignee.received_events_urlstringoptional
github.event.issue.assignee.repos_urlstringoptional
github.event.issue.assignee.site_adminbooleanoptional
github.event.issue.assignee.starred_urlstringoptional
github.event.issue.assignee.subscriptions_urlstringoptional
github.event.issue.assignee.typeBot, User, Organizationoptional
github.event.issue.assignee.urlstringoptional
github.event.issue.labelsarray of objectsoptional
github.event.issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.issue.labels.defaultbooleanrequired
github.event.issue.labels.descriptionstring or nullrequired
github.event.issue.labels.idintegerrequired
github.event.issue.labels.namestringrequired

The name of the label.

github.event.issue.labels.node_idstringrequired
github.event.issue.labels.urlstringrequired

URL for the label

github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.issue.performed_via_github_app.descriptionstring or nullrequired
github.event.issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

github.event.issue.performed_via_github_app.external_urlstring or nullrequired
github.event.issue.performed_via_github_app.html_urlstringrequired
github.event.issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.issue.performed_via_github_app.node_idstringrequired
github.event.issue.performed_via_github_app.ownerobject or nullrequired
github.event.issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.issue.performed_via_github_app.owner.events_urlstringoptional
github.event.issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.issue.performed_via_github_app.owner.following_urlstringoptional
github.event.issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.issue.performed_via_github_app.owner.html_urlstringoptional
github.event.issue.performed_via_github_app.owner.idintegerrequired
github.event.issue.performed_via_github_app.owner.loginstringrequired
github.event.issue.performed_via_github_app.owner.namestringoptional
github.event.issue.performed_via_github_app.owner.node_idstringoptional
github.event.issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_app.owner.urlstringoptional
github.event.issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.issue.performed_via_github_app.updated_atstring or nullrequired
github.event.issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.issue.user.typeBot, User, Organizationoptional

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.

fieldtyperequireddescription
github.event.actionreopenedrequired
github.event.issue.labelsarray of object,nullsoptional
github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.issue.performed_via_github_appobject or nulloptional
github.event.issue.stateopen, closedrequired
github.event.issue.user.typeBot, User, Organization, Mannequinoptional

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.

fieldtyperequireddescription
github.event.actiontransferredrequired
github.event.changesobjectrequired
github.event.changes.new_issueobjectrequired

The issue itself.

github.event.changes.new_issue.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.changes.new_issue.assigneeobject or nulloptional
github.event.changes.new_issue.assignee.avatar_urlstringoptional
github.event.changes.new_issue.assignee.deletedbooleanoptional
github.event.changes.new_issue.assignee.emailstring or nulloptional
github.event.changes.new_issue.assignee.events_urlstringoptional
github.event.changes.new_issue.assignee.followers_urlstringoptional
github.event.changes.new_issue.assignee.following_urlstringoptional
github.event.changes.new_issue.assignee.gists_urlstringoptional
github.event.changes.new_issue.assignee.gravatar_idstringoptional
github.event.changes.new_issue.assignee.html_urlstringoptional
github.event.changes.new_issue.assignee.idintegerrequired
github.event.changes.new_issue.assignee.loginstringrequired
github.event.changes.new_issue.assignee.namestringoptional
github.event.changes.new_issue.assignee.node_idstringoptional
github.event.changes.new_issue.assignee.organizations_urlstringoptional
github.event.changes.new_issue.assignee.received_events_urlstringoptional
github.event.changes.new_issue.assignee.repos_urlstringoptional
github.event.changes.new_issue.assignee.site_adminbooleanoptional
github.event.changes.new_issue.assignee.starred_urlstringoptional
github.event.changes.new_issue.assignee.subscriptions_urlstringoptional
github.event.changes.new_issue.assignee.typeBot, User, Organizationoptional
github.event.changes.new_issue.assignee.urlstringoptional
github.event.changes.new_issue.assigneesarray of object,nullsrequired
github.event.changes.new_issue.author_associationCOLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERrequired

How the author is associated with the repository.

github.event.changes.new_issue.bodystring or nullrequired

Contents of the issue

github.event.changes.new_issue.closed_atstring or nullrequired
github.event.changes.new_issue.commentsintegerrequired
github.event.changes.new_issue.comments_urlstringrequired
github.event.changes.new_issue.created_atstringrequired
github.event.changes.new_issue.draftbooleanoptional
github.event.changes.new_issue.events_urlstringrequired
github.event.changes.new_issue.html_urlstringrequired
github.event.changes.new_issue.idintegerrequired
github.event.changes.new_issue.labelsarray of objectsoptional
github.event.changes.new_issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.changes.new_issue.labels.defaultbooleanrequired
github.event.changes.new_issue.labels.descriptionstring or nullrequired
github.event.changes.new_issue.labels.idintegerrequired
github.event.changes.new_issue.labels.namestringrequired

The name of the label.

github.event.changes.new_issue.labels.node_idstringrequired
github.event.changes.new_issue.labels.urlstringrequired

URL for the label

github.event.changes.new_issue.labels_urlstringrequired
github.event.changes.new_issue.lockedbooleanoptional
github.event.changes.new_issue.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.changes.new_issue.milestone.closed_atstring or nullrequired
github.event.changes.new_issue.milestone.closed_issuesintegerrequired
github.event.changes.new_issue.milestone.created_atstringrequired
github.event.changes.new_issue.milestone.creatorobject or nullrequired
github.event.changes.new_issue.milestone.creator.avatar_urlstringoptional
github.event.changes.new_issue.milestone.creator.deletedbooleanoptional
github.event.changes.new_issue.milestone.creator.emailstring or nulloptional
github.event.changes.new_issue.milestone.creator.events_urlstringoptional
github.event.changes.new_issue.milestone.creator.followers_urlstringoptional
github.event.changes.new_issue.milestone.creator.following_urlstringoptional
github.event.changes.new_issue.milestone.creator.gists_urlstringoptional
github.event.changes.new_issue.milestone.creator.gravatar_idstringoptional
github.event.changes.new_issue.milestone.creator.html_urlstringoptional
github.event.changes.new_issue.milestone.creator.idintegerrequired
github.event.changes.new_issue.milestone.creator.loginstringrequired
github.event.changes.new_issue.milestone.creator.namestringoptional
github.event.changes.new_issue.milestone.creator.node_idstringoptional
github.event.changes.new_issue.milestone.creator.organizations_urlstringoptional
github.event.changes.new_issue.milestone.creator.received_events_urlstringoptional
github.event.changes.new_issue.milestone.creator.repos_urlstringoptional
github.event.changes.new_issue.milestone.creator.site_adminbooleanoptional
github.event.changes.new_issue.milestone.creator.starred_urlstringoptional
github.event.changes.new_issue.milestone.creator.subscriptions_urlstringoptional
github.event.changes.new_issue.milestone.creator.typeBot, User, Organizationoptional
github.event.changes.new_issue.milestone.creator.urlstringoptional
github.event.changes.new_issue.milestone.descriptionstring or nullrequired
github.event.changes.new_issue.milestone.due_onstring or nullrequired
github.event.changes.new_issue.milestone.html_urlstringrequired
github.event.changes.new_issue.milestone.idintegerrequired
github.event.changes.new_issue.milestone.labels_urlstringrequired
github.event.changes.new_issue.milestone.node_idstringrequired
github.event.changes.new_issue.milestone.numberintegerrequired

The number of the milestone.

github.event.changes.new_issue.milestone.open_issuesintegerrequired
github.event.changes.new_issue.milestone.stateopen, closedrequired

The state of the milestone.

github.event.changes.new_issue.milestone.titlestringrequired

The title of the milestone.

github.event.changes.new_issue.milestone.updated_atstringrequired
github.event.changes.new_issue.milestone.urlstringrequired
github.event.changes.new_issue.node_idstringrequired
github.event.changes.new_issue.numberintegerrequired
github.event.changes.new_issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.changes.new_issue.performed_via_github_app.descriptionstring or nullrequired
github.event.changes.new_issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

github.event.changes.new_issue.performed_via_github_app.external_urlstring or nullrequired
github.event.changes.new_issue.performed_via_github_app.html_urlstringrequired
github.event.changes.new_issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.changes.new_issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.changes.new_issue.performed_via_github_app.node_idstringrequired
github.event.changes.new_issue.performed_via_github_app.ownerobject or nullrequired
github.event.changes.new_issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.changes.new_issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.changes.new_issue.performed_via_github_app.owner.events_urlstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.following_urlstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.html_urlstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.idintegerrequired
github.event.changes.new_issue.performed_via_github_app.owner.loginstringrequired
github.event.changes.new_issue.performed_via_github_app.owner.namestringoptional
github.event.changes.new_issue.performed_via_github_app.owner.node_idstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.changes.new_issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.changes.new_issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.changes.new_issue.performed_via_github_app.owner.urlstringoptional
github.event.changes.new_issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.changes.new_issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.organization_projectsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.changes.new_issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.changes.new_issue.performed_via_github_app.updated_atstring or nullrequired
github.event.changes.new_issue.pull_requestobjectoptional
github.event.changes.new_issue.pull_request.diff_urlstringoptional
github.event.changes.new_issue.pull_request.html_urlstringoptional
github.event.changes.new_issue.pull_request.merged_atstring or nulloptional
github.event.changes.new_issue.pull_request.patch_urlstringoptional
github.event.changes.new_issue.pull_request.urlstringoptional
github.event.changes.new_issue.reactionsobjectrequired
github.event.changes.new_issue.reactions.+1integerrequired
github.event.changes.new_issue.reactions.-1integerrequired
github.event.changes.new_issue.reactions.confusedintegerrequired
github.event.changes.new_issue.reactions.eyesintegerrequired
github.event.changes.new_issue.reactions.heartintegerrequired
github.event.changes.new_issue.reactions.hoorayintegerrequired
github.event.changes.new_issue.reactions.laughintegerrequired
github.event.changes.new_issue.reactions.rocketintegerrequired
github.event.changes.new_issue.reactions.total_countintegerrequired
github.event.changes.new_issue.reactions.urlstringrequired
github.event.changes.new_issue.repository_urlstringrequired
github.event.changes.new_issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.changes.new_issue.state_reasonstring or nulloptional
github.event.changes.new_issue.timeline_urlstringoptional
github.event.changes.new_issue.titlestringrequired

Title of the issue

github.event.changes.new_issue.updated_atstringrequired
github.event.changes.new_issue.urlstringrequired

URL for the issue

github.event.changes.new_issue.userobject or nullrequired
github.event.changes.new_issue.user.avatar_urlstringoptional
github.event.changes.new_issue.user.deletedbooleanoptional
github.event.changes.new_issue.user.emailstring or nulloptional
github.event.changes.new_issue.user.events_urlstringoptional
github.event.changes.new_issue.user.followers_urlstringoptional
github.event.changes.new_issue.user.following_urlstringoptional
github.event.changes.new_issue.user.gists_urlstringoptional
github.event.changes.new_issue.user.gravatar_idstringoptional
github.event.changes.new_issue.user.html_urlstringoptional
github.event.changes.new_issue.user.idintegerrequired
github.event.changes.new_issue.user.loginstringrequired
github.event.changes.new_issue.user.namestringoptional
github.event.changes.new_issue.user.node_idstringoptional
github.event.changes.new_issue.user.organizations_urlstringoptional
github.event.changes.new_issue.user.received_events_urlstringoptional
github.event.changes.new_issue.user.repos_urlstringoptional
github.event.changes.new_issue.user.site_adminbooleanoptional
github.event.changes.new_issue.user.starred_urlstringoptional
github.event.changes.new_issue.user.subscriptions_urlstringoptional
github.event.changes.new_issue.user.typeBot, User, Organizationoptional
github.event.changes.new_issue.user.urlstringoptional
github.event.changes.new_repositoryobjectrequired

A git repository

github.event.changes.new_repository.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.changes.new_repository.allow_forkingbooleanoptional

Whether to allow private forks

github.event.changes.new_repository.allow_merge_commitbooleanoptional

Whether to allow merge commits for pull requests.

github.event.changes.new_repository.allow_rebase_mergebooleanoptional

Whether to allow rebase merges for pull requests.

github.event.changes.new_repository.allow_squash_mergebooleanoptional

Whether to allow squash merges for pull requests.

github.event.changes.new_repository.allow_update_branchbooleanoptional
github.event.changes.new_repository.archive_urlstringrequired
github.event.changes.new_repository.archivedbooleanrequired

Whether the repository is archived.

github.event.changes.new_repository.assignees_urlstringrequired
github.event.changes.new_repository.blobs_urlstringrequired
github.event.changes.new_repository.branches_urlstringrequired
github.event.changes.new_repository.clone_urlstringrequired
github.event.changes.new_repository.collaborators_urlstringrequired
github.event.changes.new_repository.comments_urlstringrequired
github.event.changes.new_repository.commits_urlstringrequired
github.event.changes.new_repository.compare_urlstringrequired
github.event.changes.new_repository.contents_urlstringrequired
github.event.changes.new_repository.contributors_urlstringrequired
github.event.changes.new_repository.created_atinteger or stringrequired
github.event.changes.new_repository.custom_propertiesobjectoptional

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_branchstringrequired

The default branch of the repository.

github.event.changes.new_repository.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.changes.new_repository.deployments_urlstringrequired
github.event.changes.new_repository.descriptionstring or nullrequired
github.event.changes.new_repository.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.changes.new_repository.downloads_urlstringrequired
github.event.changes.new_repository.events_urlstringrequired
github.event.changes.new_repository.forkbooleanrequired
github.event.changes.new_repository.forksintegerrequired
github.event.changes.new_repository.forks_countintegerrequired
github.event.changes.new_repository.forks_urlstringrequired
github.event.changes.new_repository.full_namestringrequired
github.event.changes.new_repository.git_commits_urlstringrequired
github.event.changes.new_repository.git_refs_urlstringrequired
github.event.changes.new_repository.git_tags_urlstringrequired
github.event.changes.new_repository.git_urlstringrequired
github.event.changes.new_repository.has_downloadsbooleanrequired

Whether downloads are enabled.

github.event.changes.new_repository.has_issuesbooleanrequired

Whether issues are enabled.

github.event.changes.new_repository.has_pagesbooleanrequired
github.event.changes.new_repository.has_projectsbooleanrequired

Whether projects are enabled.

github.event.changes.new_repository.has_wikibooleanrequired

Whether the wiki is enabled.

github.event.changes.new_repository.has_discussionsbooleanrequired

Whether discussions are enabled.

github.event.changes.new_repository.homepagestring or nullrequired
github.event.changes.new_repository.hooks_urlstringrequired
github.event.changes.new_repository.html_urlstringrequired
github.event.changes.new_repository.idintegerrequired

Unique identifier of the repository

github.event.changes.new_repository.is_templatebooleanoptional
github.event.changes.new_repository.issue_comment_urlstringrequired
github.event.changes.new_repository.issue_events_urlstringrequired
github.event.changes.new_repository.issues_urlstringrequired
github.event.changes.new_repository.keys_urlstringrequired
github.event.changes.new_repository.labels_urlstringrequired
github.event.changes.new_repository.languagestring or nullrequired
github.event.changes.new_repository.languages_urlstringrequired
github.event.changes.new_repository.licenseobject or nullrequired
github.event.changes.new_repository.license.keystringrequired
github.event.changes.new_repository.license.namestringrequired
github.event.changes.new_repository.license.node_idstringrequired
github.event.changes.new_repository.license.spdx_idstringrequired
github.event.changes.new_repository.license.urlstring or nullrequired
github.event.changes.new_repository.master_branchstringoptional
github.event.changes.new_repository.merges_urlstringrequired
github.event.changes.new_repository.milestones_urlstringrequired
github.event.changes.new_repository.mirror_urlstring or nullrequired
github.event.changes.new_repository.namestringrequired

The name of the repository.

github.event.changes.new_repository.node_idstringrequired
github.event.changes.new_repository.notifications_urlstringrequired
github.event.changes.new_repository.open_issuesintegerrequired
github.event.changes.new_repository.open_issues_countintegerrequired
github.event.changes.new_repository.organizationstringoptional
github.event.changes.new_repository.ownerobject or nullrequired
github.event.changes.new_repository.owner.avatar_urlstringoptional
github.event.changes.new_repository.owner.deletedbooleanoptional
github.event.changes.new_repository.owner.emailstring or nulloptional
github.event.changes.new_repository.owner.events_urlstringoptional
github.event.changes.new_repository.owner.followers_urlstringoptional
github.event.changes.new_repository.owner.following_urlstringoptional
github.event.changes.new_repository.owner.gists_urlstringoptional
github.event.changes.new_repository.owner.gravatar_idstringoptional
github.event.changes.new_repository.owner.html_urlstringoptional
github.event.changes.new_repository.owner.idintegerrequired
github.event.changes.new_repository.owner.loginstringrequired
github.event.changes.new_repository.owner.namestringoptional
github.event.changes.new_repository.owner.node_idstringoptional
github.event.changes.new_repository.owner.organizations_urlstringoptional
github.event.changes.new_repository.owner.received_events_urlstringoptional
github.event.changes.new_repository.owner.repos_urlstringoptional
github.event.changes.new_repository.owner.site_adminbooleanoptional
github.event.changes.new_repository.owner.starred_urlstringoptional
github.event.changes.new_repository.owner.subscriptions_urlstringoptional
github.event.changes.new_repository.owner.typeBot, User, Organizationoptional
github.event.changes.new_repository.owner.urlstringoptional
github.event.changes.new_repository.permissionsobjectoptional
github.event.changes.new_repository.permissions.adminbooleanrequired
github.event.changes.new_repository.permissions.maintainbooleanoptional
github.event.changes.new_repository.permissions.pullbooleanrequired
github.event.changes.new_repository.permissions.pushbooleanrequired
github.event.changes.new_repository.permissions.triagebooleanoptional
github.event.changes.new_repository.privatebooleanrequired

Whether the repository is private or public.

github.event.changes.new_repository.publicbooleanoptional
github.event.changes.new_repository.pulls_urlstringrequired
github.event.changes.new_repository.pushed_atnull or integer or stringrequired
github.event.changes.new_repository.releases_urlstringrequired
github.event.changes.new_repository.role_namestring or nulloptional
github.event.changes.new_repository.sizeintegerrequired
github.event.changes.new_repository.ssh_urlstringrequired
github.event.changes.new_repository.stargazersintegeroptional
github.event.changes.new_repository.stargazers_countintegerrequired
github.event.changes.new_repository.stargazers_urlstringrequired
github.event.changes.new_repository.statuses_urlstringrequired
github.event.changes.new_repository.subscribers_urlstringrequired
github.event.changes.new_repository.subscription_urlstringrequired
github.event.changes.new_repository.svn_urlstringrequired
github.event.changes.new_repository.tags_urlstringrequired
github.event.changes.new_repository.teams_urlstringrequired
github.event.changes.new_repository.topicsarray of stringsrequired
github.event.changes.new_repository.trees_urlstringrequired
github.event.changes.new_repository.updated_atstringrequired
github.event.changes.new_repository.urlstringrequired
github.event.changes.new_repository.visibilitypublic, private, internalrequired
github.event.changes.new_repository.watchersintegerrequired
github.event.changes.new_repository.watchers_countintegerrequired
github.event.changes.new_repository.web_commit_signoff_requiredbooleanoptional

Whether to require contributors to sign off on web-based commits

github.event.issue.assignee.avatar_urlstringoptional
github.event.issue.assignee.deletedbooleanoptional
github.event.issue.assignee.emailstring or nulloptional
github.event.issue.assignee.events_urlstringoptional
github.event.issue.assignee.followers_urlstringoptional
github.event.issue.assignee.following_urlstringoptional
github.event.issue.assignee.gists_urlstringoptional
github.event.issue.assignee.gravatar_idstringoptional
github.event.issue.assignee.html_urlstringoptional
github.event.issue.assignee.idintegerrequired
github.event.issue.assignee.loginstringrequired
github.event.issue.assignee.namestringoptional
github.event.issue.assignee.node_idstringoptional
github.event.issue.assignee.organizations_urlstringoptional
github.event.issue.assignee.received_events_urlstringoptional
github.event.issue.assignee.repos_urlstringoptional
github.event.issue.assignee.site_adminbooleanoptional
github.event.issue.assignee.starred_urlstringoptional
github.event.issue.assignee.subscriptions_urlstringoptional
github.event.issue.assignee.typeBot, User, Organizationoptional
github.event.issue.assignee.urlstringoptional
github.event.issue.labelsarray of objectsoptional
github.event.issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.issue.labels.defaultbooleanrequired
github.event.issue.labels.descriptionstring or nullrequired
github.event.issue.labels.idintegerrequired
github.event.issue.labels.namestringrequired

The name of the label.

github.event.issue.labels.node_idstringrequired
github.event.issue.labels.urlstringrequired

URL for the label

github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.issue.performed_via_github_app.descriptionstring or nullrequired
github.event.issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

github.event.issue.performed_via_github_app.external_urlstring or nullrequired
github.event.issue.performed_via_github_app.html_urlstringrequired
github.event.issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.issue.performed_via_github_app.node_idstringrequired
github.event.issue.performed_via_github_app.ownerobject or nullrequired
github.event.issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.issue.performed_via_github_app.owner.events_urlstringoptional
github.event.issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.issue.performed_via_github_app.owner.following_urlstringoptional
github.event.issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.issue.performed_via_github_app.owner.html_urlstringoptional
github.event.issue.performed_via_github_app.owner.idintegerrequired
github.event.issue.performed_via_github_app.owner.loginstringrequired
github.event.issue.performed_via_github_app.owner.namestringoptional
github.event.issue.performed_via_github_app.owner.node_idstringoptional
github.event.issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_app.owner.urlstringoptional
github.event.issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.issue.performed_via_github_app.updated_atstring or nullrequired
github.event.issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.issue.user.typeBot, User, Organizationoptional

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.

fieldtyperequireddescription
github.event.actionunassignedrequired

The action that was performed.

github.event.assigneeobject or nulloptional
github.event.assignee.avatar_urlstringoptional
github.event.assignee.deletedbooleanoptional
github.event.assignee.emailstring or nulloptional
github.event.assignee.events_urlstringoptional
github.event.assignee.followers_urlstringoptional
github.event.assignee.following_urlstringoptional
github.event.assignee.gists_urlstringoptional
github.event.assignee.gravatar_idstringoptional
github.event.assignee.html_urlstringoptional
github.event.assignee.idintegerrequired
github.event.assignee.loginstringrequired
github.event.assignee.namestringoptional
github.event.assignee.node_idstringoptional
github.event.assignee.organizations_urlstringoptional
github.event.assignee.received_events_urlstringoptional
github.event.assignee.repos_urlstringoptional
github.event.assignee.site_adminbooleanoptional
github.event.assignee.starred_urlstringoptional
github.event.assignee.subscriptions_urlstringoptional
github.event.assignee.typeBot, User, Organization, Mannequinoptional
github.event.assignee.urlstringoptional
github.event.issue.assignee.avatar_urlstringoptional
github.event.issue.assignee.deletedbooleanoptional
github.event.issue.assignee.emailstring or nulloptional
github.event.issue.assignee.events_urlstringoptional
github.event.issue.assignee.followers_urlstringoptional
github.event.issue.assignee.following_urlstringoptional
github.event.issue.assignee.gists_urlstringoptional
github.event.issue.assignee.gravatar_idstringoptional
github.event.issue.assignee.html_urlstringoptional
github.event.issue.assignee.idintegerrequired
github.event.issue.assignee.loginstringrequired
github.event.issue.assignee.namestringoptional
github.event.issue.assignee.node_idstringoptional
github.event.issue.assignee.organizations_urlstringoptional
github.event.issue.assignee.received_events_urlstringoptional
github.event.issue.assignee.repos_urlstringoptional
github.event.issue.assignee.site_adminbooleanoptional
github.event.issue.assignee.starred_urlstringoptional
github.event.issue.assignee.subscriptions_urlstringoptional
github.event.issue.assignee.typeBot, User, Organization, Mannequinoptional
github.event.issue.assignee.urlstringoptional
github.event.issue.labelsarray of objectsoptional
github.event.issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.issue.labels.defaultbooleanrequired
github.event.issue.labels.descriptionstring or nullrequired
github.event.issue.labels.idintegerrequired
github.event.issue.labels.namestringrequired

The name of the label.

github.event.issue.labels.node_idstringrequired
github.event.issue.labels.urlstringrequired

URL for the label

github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.issue.performed_via_github_app.descriptionstring or nullrequired
github.event.issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

github.event.issue.performed_via_github_app.external_urlstring or nullrequired
github.event.issue.performed_via_github_app.html_urlstringrequired
github.event.issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.issue.performed_via_github_app.node_idstringrequired
github.event.issue.performed_via_github_app.ownerobject or nullrequired
github.event.issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.issue.performed_via_github_app.owner.events_urlstringoptional
github.event.issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.issue.performed_via_github_app.owner.following_urlstringoptional
github.event.issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.issue.performed_via_github_app.owner.html_urlstringoptional
github.event.issue.performed_via_github_app.owner.idintegerrequired
github.event.issue.performed_via_github_app.owner.loginstringrequired
github.event.issue.performed_via_github_app.owner.namestringoptional
github.event.issue.performed_via_github_app.owner.node_idstringoptional
github.event.issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_app.owner.urlstringoptional
github.event.issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_projectsread, write, adminoptional
github.event.issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.issue.performed_via_github_app.updated_atstring or nullrequired
github.event.issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.issue.user.typeBot, User, Organization, Mannequinoptional

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.

fieldtyperequireddescription
github.event.actionunlabeledrequired
github.event.issue.assignee.avatar_urlstringoptional
github.event.issue.assignee.deletedbooleanoptional
github.event.issue.assignee.emailstring or nulloptional
github.event.issue.assignee.events_urlstringoptional
github.event.issue.assignee.followers_urlstringoptional
github.event.issue.assignee.following_urlstringoptional
github.event.issue.assignee.gists_urlstringoptional
github.event.issue.assignee.gravatar_idstringoptional
github.event.issue.assignee.html_urlstringoptional
github.event.issue.assignee.idintegerrequired
github.event.issue.assignee.loginstringrequired
github.event.issue.assignee.namestringoptional
github.event.issue.assignee.node_idstringoptional
github.event.issue.assignee.organizations_urlstringoptional
github.event.issue.assignee.received_events_urlstringoptional
github.event.issue.assignee.repos_urlstringoptional
github.event.issue.assignee.site_adminbooleanoptional
github.event.issue.assignee.starred_urlstringoptional
github.event.issue.assignee.subscriptions_urlstringoptional
github.event.issue.assignee.typeBot, User, Organization, Mannequinoptional
github.event.issue.assignee.urlstringoptional
github.event.issue.labelsarray of objectsoptional
github.event.issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.issue.labels.defaultbooleanrequired
github.event.issue.labels.descriptionstring or nullrequired
github.event.issue.labels.idintegerrequired
github.event.issue.labels.namestringrequired

The name of the label.

github.event.issue.labels.node_idstringrequired
github.event.issue.labels.urlstringrequired

URL for the label

github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.issue.performed_via_github_app.descriptionstring or nullrequired
github.event.issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

github.event.issue.performed_via_github_app.external_urlstring or nullrequired
github.event.issue.performed_via_github_app.html_urlstringrequired
github.event.issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.issue.performed_via_github_app.node_idstringrequired
github.event.issue.performed_via_github_app.ownerobject or nullrequired
github.event.issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.issue.performed_via_github_app.owner.events_urlstringoptional
github.event.issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.issue.performed_via_github_app.owner.following_urlstringoptional
github.event.issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.issue.performed_via_github_app.owner.html_urlstringoptional
github.event.issue.performed_via_github_app.owner.idintegerrequired
github.event.issue.performed_via_github_app.owner.loginstringrequired
github.event.issue.performed_via_github_app.owner.namestringoptional
github.event.issue.performed_via_github_app.owner.node_idstringoptional
github.event.issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_app.owner.urlstringoptional
github.event.issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_projectsread, write, adminoptional
github.event.issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.issue.performed_via_github_app.updated_atstring or nullrequired
github.event.issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.issue.user.typeBot, User, Organization, Mannequinoptional
github.event.labelobjectoptional
github.event.label.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.label.defaultbooleanrequired
github.event.label.descriptionstring or nullrequired
github.event.label.idintegerrequired
github.event.label.namestringrequired

The name of the label.

github.event.label.node_idstringrequired
github.event.label.urlstringrequired

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.

fieldtyperequireddescription
github.event.actionunlockedrequired
github.event.issue.labelsarray of object,nullsoptional
github.event.issue.lockedFalserequired
github.event.issue.milestone.creator.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_appnulloptional
github.event.issue.statestringoptional
github.event.issue.user.typeBot, User, Organizationoptional

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.

fieldtyperequireddescription
github.event.actionunpinnedrequired
github.event.issue.assignee.avatar_urlstringoptional
github.event.issue.assignee.deletedbooleanoptional
github.event.issue.assignee.emailstring or nulloptional
github.event.issue.assignee.events_urlstringoptional
github.event.issue.assignee.followers_urlstringoptional
github.event.issue.assignee.following_urlstringoptional
github.event.issue.assignee.gists_urlstringoptional
github.event.issue.assignee.gravatar_idstringoptional
github.event.issue.assignee.html_urlstringoptional
github.event.issue.assignee.idintegerrequired
github.event.issue.assignee.loginstringrequired
github.event.issue.assignee.namestringoptional
github.event.issue.assignee.node_idstringoptional
github.event.issue.assignee.organizations_urlstringoptional
github.event.issue.assignee.received_events_urlstringoptional
github.event.issue.assignee.repos_urlstringoptional
github.event.issue.assignee.site_adminbooleanoptional
github.event.issue.assignee.starred_urlstringoptional
github.event.issue.assignee.subscriptions_urlstringoptional
github.event.issue.assignee.typeBot, User, Organizationoptional
github.event.issue.assignee.urlstringoptional
github.event.issue.labelsarray of objectsoptional
github.event.issue.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.issue.labels.defaultbooleanrequired
github.event.issue.labels.descriptionstring or nullrequired
github.event.issue.labels.idintegerrequired
github.event.issue.labels.namestringrequired

The name of the label.

github.event.issue.labels.node_idstringrequired
github.event.issue.labels.urlstringrequired

URL for the label

github.event.issue.lockedbooleanoptional
github.event.issue.milestone.creator.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_appobject or nulloptional

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_atstring or nullrequired
github.event.issue.performed_via_github_app.descriptionstring or nullrequired
github.event.issue.performed_via_github_app.eventsarray of stringsoptional

The list of events for the GitHub app Supported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

github.event.issue.performed_via_github_app.external_urlstring or nullrequired
github.event.issue.performed_via_github_app.html_urlstringrequired
github.event.issue.performed_via_github_app.idinteger or nullrequired

Unique identifier of the GitHub app

github.event.issue.performed_via_github_app.namestringrequired

The name of the GitHub app

github.event.issue.performed_via_github_app.node_idstringrequired
github.event.issue.performed_via_github_app.ownerobject or nullrequired
github.event.issue.performed_via_github_app.owner.avatar_urlstringoptional
github.event.issue.performed_via_github_app.owner.deletedbooleanoptional
github.event.issue.performed_via_github_app.owner.emailstring or nulloptional
github.event.issue.performed_via_github_app.owner.events_urlstringoptional
github.event.issue.performed_via_github_app.owner.followers_urlstringoptional
github.event.issue.performed_via_github_app.owner.following_urlstringoptional
github.event.issue.performed_via_github_app.owner.gists_urlstringoptional
github.event.issue.performed_via_github_app.owner.gravatar_idstringoptional
github.event.issue.performed_via_github_app.owner.html_urlstringoptional
github.event.issue.performed_via_github_app.owner.idintegerrequired
github.event.issue.performed_via_github_app.owner.loginstringrequired
github.event.issue.performed_via_github_app.owner.namestringoptional
github.event.issue.performed_via_github_app.owner.node_idstringoptional
github.event.issue.performed_via_github_app.owner.organizations_urlstringoptional
github.event.issue.performed_via_github_app.owner.received_events_urlstringoptional
github.event.issue.performed_via_github_app.owner.repos_urlstringoptional
github.event.issue.performed_via_github_app.owner.site_adminbooleanoptional
github.event.issue.performed_via_github_app.owner.starred_urlstringoptional
github.event.issue.performed_via_github_app.owner.subscriptions_urlstringoptional
github.event.issue.performed_via_github_app.owner.typeBot, User, Organizationoptional
github.event.issue.performed_via_github_app.owner.urlstringoptional
github.event.issue.performed_via_github_app.permissionsobjectoptional

The set of permissions for the GitHub app

github.event.issue.performed_via_github_app.permissions.actionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.checksread, writeoptional
github.event.issue.performed_via_github_app.permissions.content_referencesread, writeoptional
github.event.issue.performed_via_github_app.permissions.contentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.deploymentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.emailsread, writeoptional
github.event.issue.performed_via_github_app.permissions.environmentsread, writeoptional
github.event.issue.performed_via_github_app.permissions.issuesread, writeoptional
github.event.issue.performed_via_github_app.permissions.keysread, writeoptional
github.event.issue.performed_via_github_app.permissions.membersread, writeoptional
github.event.issue.performed_via_github_app.permissions.metadataread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_administrationread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_planread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_self_hosted_runnersread, writeoptional
github.event.issue.performed_via_github_app.permissions.organization_user_blockingread, writeoptional
github.event.issue.performed_via_github_app.permissions.packagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pagesread, writeoptional
github.event.issue.performed_via_github_app.permissions.pull_requestsread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_hooksread, writeoptional
github.event.issue.performed_via_github_app.permissions.repository_projectsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secret_scanning_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.secretsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_eventsread, writeoptional
github.event.issue.performed_via_github_app.permissions.security_scanning_alertread, writeoptional
github.event.issue.performed_via_github_app.permissions.single_fileread, writeoptional
github.event.issue.performed_via_github_app.permissions.statusesread, writeoptional
github.event.issue.performed_via_github_app.permissions.team_discussionsread, writeoptional
github.event.issue.performed_via_github_app.permissions.vulnerability_alertsread, writeoptional
github.event.issue.performed_via_github_app.permissions.workflowsread, writeoptional
github.event.issue.performed_via_github_app.slugstringoptional

The slug name of the GitHub app

github.event.issue.performed_via_github_app.updated_atstring or nullrequired
github.event.issue.stateopen, closedoptional

State of the issue; either ‘open’ or ‘closed’

github.event.issue.user.typeBot, User, Organizationoptional