This page was generated based on Github’s Documentation. See our welcome page for context and details.
Github Event discussion_comment
#
Github Action Trigger #
Webhook event payload | Activity types | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
discussion_comment | - created - edited - deleted | Last commit on default branch | Default branch |
Note: More than one activity type triggers this event. For information about each activity type, see “Webhook events and payloads.” By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the types
keyword. For more information, see “Workflow syntax for GitHub Actions.”
Note: This event will only trigger a workflow run if the workflow file is on the default branch.
Note: Webhook events for GitHub Discussions are currently in beta and subject to change.
Runs your workflow when a comment on a discussion in the workflow’s repository is created or modified. For activity related to a discussion as opposed to comments on the discussion, use the discussion
event. For more information about discussions, see “About discussions.” For information about the GraphQL API, see “Objects.”
For example, you can run a workflow when a discussion comment has been created
or deleted
.
on:
discussion_comment:
types: [created, deleted]
Event Payload #
Activities: created
, deleted
, edited
Common Fields #
These fields are common to every event types available with this trigger.
field | type | required | description |
---|---|---|---|
github.event.comment | object | required | |
github.event.comment.author_association | COLLABORATOR , CONTRIBUTOR , FIRST_TIMER , FIRST_TIME_CONTRIBUTOR , MANNEQUIN , MEMBER , NONE , OWNER | required | How the author is associated with the repository. |
github.event.comment.body | string | required | |
github.event.comment.child_comment_count | integer | required | |
github.event.comment.created_at | string | required | |
github.event.comment.discussion_id | integer | required | |
github.event.comment.html_url | string | required | |
github.event.comment.id | integer | required | |
github.event.comment.node_id | string | required | |
github.event.comment.parent_id | integer or null | required | |
github.event.comment.reactions | object | required | |
github.event.comment.reactions.+1 | integer | required | |
github.event.comment.reactions.-1 | integer | required | |
github.event.comment.reactions.confused | integer | required | |
github.event.comment.reactions.eyes | integer | required | |
github.event.comment.reactions.heart | integer | required | |
github.event.comment.reactions.hooray | integer | required | |
github.event.comment.reactions.laugh | integer | required | |
github.event.comment.reactions.rocket | integer | required | |
github.event.comment.reactions.total_count | integer | required | |
github.event.comment.reactions.url | string | required | |
github.event.comment.repository_url | string | required | |
github.event.comment.updated_at | string | required | |
github.event.comment.user | object or null | required | |
github.event.comment.user.avatar_url | string | optional | |
github.event.comment.user.deleted | boolean | optional | |
github.event.comment.user.email | string or null | optional | |
github.event.comment.user.events_url | string | optional | |
github.event.comment.user.followers_url | string | optional | |
github.event.comment.user.following_url | string | optional | |
github.event.comment.user.gists_url | string | optional | |
github.event.comment.user.gravatar_id | string | optional | |
github.event.comment.user.html_url | string | optional | |
github.event.comment.user.id | integer | required | |
github.event.comment.user.login | string | required | |
github.event.comment.user.name | string | optional | |
github.event.comment.user.node_id | string | optional | |
github.event.comment.user.organizations_url | string | optional | |
github.event.comment.user.received_events_url | string | optional | |
github.event.comment.user.repos_url | string | optional | |
github.event.comment.user.site_admin | boolean | optional | |
github.event.comment.user.starred_url | string | optional | |
github.event.comment.user.subscriptions_url | string | optional | |
github.event.comment.user.type | Bot , User , Organization | optional | |
github.event.comment.user.url | string | optional | |
github.event.discussion | object | required | A Discussion in a repository. |
github.event.discussion.active_lock_reason | string or null | required | |
github.event.discussion.answer_chosen_at | string or null | required | |
github.event.discussion.answer_chosen_by | object or null | required | |
github.event.discussion.answer_chosen_by.avatar_url | string | optional | |
github.event.discussion.answer_chosen_by.deleted | boolean | optional | |
github.event.discussion.answer_chosen_by.email | string or null | optional | |
github.event.discussion.answer_chosen_by.events_url | string | optional | |
github.event.discussion.answer_chosen_by.followers_url | string | optional | |
github.event.discussion.answer_chosen_by.following_url | string | optional | |
github.event.discussion.answer_chosen_by.gists_url | string | optional | |
github.event.discussion.answer_chosen_by.gravatar_id | string | optional | |
github.event.discussion.answer_chosen_by.html_url | string | optional | |
github.event.discussion.answer_chosen_by.id | integer | required | |
github.event.discussion.answer_chosen_by.login | string | required | |
github.event.discussion.answer_chosen_by.name | string | optional | |
github.event.discussion.answer_chosen_by.node_id | string | optional | |
github.event.discussion.answer_chosen_by.organizations_url | string | optional | |
github.event.discussion.answer_chosen_by.received_events_url | string | optional | |
github.event.discussion.answer_chosen_by.repos_url | string | optional | |
github.event.discussion.answer_chosen_by.site_admin | boolean | optional | |
github.event.discussion.answer_chosen_by.starred_url | string | optional | |
github.event.discussion.answer_chosen_by.subscriptions_url | string | optional | |
github.event.discussion.answer_chosen_by.type | Bot , User , Organization | optional | |
github.event.discussion.answer_chosen_by.url | string | optional | |
github.event.discussion.answer_html_url | string or null | required | |
github.event.discussion.author_association | COLLABORATOR , CONTRIBUTOR , FIRST_TIMER , FIRST_TIME_CONTRIBUTOR , MANNEQUIN , MEMBER , NONE , OWNER | required | How the author is associated with the repository. |
github.event.discussion.body | string | required | |
github.event.discussion.category | object | required | |
github.event.discussion.category.created_at | string | required | |
github.event.discussion.category.description | string | required | |
github.event.discussion.category.emoji | string | required | |
github.event.discussion.category.id | integer | required | |
github.event.discussion.category.is_answerable | boolean | required | |
github.event.discussion.category.name | string | required | |
github.event.discussion.category.node_id | string | optional | |
github.event.discussion.category.repository_id | integer | required | |
github.event.discussion.category.slug | string | required | |
github.event.discussion.category.updated_at | string | required | |
github.event.discussion.comments | integer | required | |
github.event.discussion.created_at | string | required | |
github.event.discussion.html_url | string | required | |
github.event.discussion.id | integer | required | |
github.event.discussion.locked | boolean | required | |
github.event.discussion.node_id | string | required | |
github.event.discussion.number | integer | required | |
github.event.discussion.reactions | object | optional | |
github.event.discussion.reactions.+1 | integer | required | |
github.event.discussion.reactions.-1 | integer | required | |
github.event.discussion.reactions.confused | integer | required | |
github.event.discussion.reactions.eyes | integer | required | |
github.event.discussion.reactions.heart | integer | required | |
github.event.discussion.reactions.hooray | integer | required | |
github.event.discussion.reactions.laugh | integer | required | |
github.event.discussion.reactions.rocket | integer | required | |
github.event.discussion.reactions.total_count | integer | required | |
github.event.discussion.reactions.url | string | required | |
github.event.discussion.repository_url | string | required | |
github.event.discussion.state | open , closed , locked , converting , transferring | required | The current state of the discussion. |
github.event.discussion.state_reason | resolved , outdated , duplicate , reopened , None | required | The reason for the current state |
github.event.discussion.timeline_url | string | optional | |
github.event.discussion.title | string | required | |
github.event.discussion.updated_at | string | required | |
github.event.discussion.user | object or null | required | |
github.event.discussion.user.avatar_url | string | optional | |
github.event.discussion.user.deleted | boolean | optional | |
github.event.discussion.user.email | string or null | optional | |
github.event.discussion.user.events_url | string | optional | |
github.event.discussion.user.followers_url | string | optional | |
github.event.discussion.user.following_url | string | optional | |
github.event.discussion.user.gists_url | string | optional | |
github.event.discussion.user.gravatar_id | string | optional | |
github.event.discussion.user.html_url | string | optional | |
github.event.discussion.user.id | integer | required | |
github.event.discussion.user.login | string | required | |
github.event.discussion.user.name | string | optional | |
github.event.discussion.user.node_id | string | optional | |
github.event.discussion.user.organizations_url | string | optional | |
github.event.discussion.user.received_events_url | string | optional | |
github.event.discussion.user.repos_url | string | optional | |
github.event.discussion.user.site_admin | boolean | optional | |
github.event.discussion.user.starred_url | string | optional | |
github.event.discussion.user.subscriptions_url | string | optional | |
github.event.discussion.user.type | Bot , User , Organization | optional | |
github.event.discussion.user.url | string | optional | |
github.event.enterprise | object | optional | An enterprise on GitHub. Webhook payloads contain the |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.organization | object | optional | A GitHub organization. Webhook payloads contain the |
github.event.repository | object | required | The repository on GitHub where the event occurred. Webhook payloads contain the |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
created
#
This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "GitHub Discussions." For information about the API to manage discussions, see the GraphQL documentation.
For activity relating to a discussion as opposed to comments on a discussion, use the discussion
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
Note: Webhook events for GitHub Discussions are currently in beta and subject to change.
field | type | required | description |
---|---|---|---|
github.event.action | created | required |
deleted
#
This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "GitHub Discussions." For information about the API to manage discussions, see the GraphQL documentation.
For activity relating to a discussion as opposed to comments on a discussion, use the discussion
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
Note: Webhook events for GitHub Discussions are currently in beta and subject to change.
field | type | required | description |
---|---|---|---|
github.event.action | deleted | required |
edited
#
This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "GitHub Discussions." For information about the API to manage discussions, see the GraphQL documentation.
For activity relating to a discussion as opposed to comments on a discussion, use the discussion
event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
Note: Webhook events for GitHub Discussions are currently in beta and subject to change.
field | type | required | description |
---|---|---|---|
github.event.action | edited | required | |
github.event.changes | object | required | |
github.event.changes.body | object | required | |
github.event.changes.body.from | string | required |