Issues
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.
Actions
| Action | Sent when |
|---|---|
assigned | An issue was assigned to a user. |
closed | An issue was closed. |
deleted | An issue was deleted. |
demilestoned | An issue was removed from a milestone. |
edited | The title or body on an issue was edited. |
field-added | An issue field value was set or updated on an issue. |
field-removed | An issue field value was cleared from an issue. |
labeled | A label was added to an issue. |
locked | Conversation on an issue was locked. For more information, see "Locking conversations." |
milestoned | An issue was added to a milestone. |
opened | An issue was created. When a closed issue is reopened, the action will be reopened instead. |
pinned | An issue was pinned to a repository. For more information, see "Pinning an issue to your repository." |
reopened | A closed issue was reopened. |
transferred | An issue was transferred to another repository. For more information, see "Transferring an issue to another repository." |
typed | An issue type was added to an issue. |
unassigned | A user was unassigned from an issue. |
unlabeled | A label was removed from an issue. |
unlocked | Conversation on an issue was locked. For more information, see "Locking conversations." |
unpinned | An issue was unpinned from a repository. For more information, see "Pinning an issue to your repository." |
untyped | An issue type was removed from an issue. |
Payload
Fields of the delivery for the first action above. Every action shares the event's core fields.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | Yes | The action that was performed. |
assignee | object | No | |
enterprise | object | No | An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured |
installation | object | No | The GitHub App installation. Webhook payloads contain the installation property when the event is configured |
issue | object | Yes | The issue itself. |
organization | object | No | A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an |
repository | object | Yes | The repository on GitHub where the event occurred. Webhook payloads contain the repository property |
sender | object | Yes | A GitHub user. |
Subscribing
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.