discussion_comment

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

Github Event discussion_comment #

Github Action Trigger #

source

Webhook event payloadActivity typesGITHUB_SHAGITHUB_REF
discussion_commentcreated
edited
deleted
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.

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 #

source

Activities: created, deleted, edited

Common Fields #

These fields are common to every event types available with this trigger.
fieldtyperequireddescription
github.event.commentobjectrequired
github.event.comment.author_associationCOLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERrequired

How the author is associated with the repository.

github.event.comment.bodystringrequired
github.event.comment.child_comment_countintegerrequired
github.event.comment.created_atstringrequired
github.event.comment.discussion_idintegerrequired
github.event.comment.html_urlstringrequired
github.event.comment.idintegerrequired
github.event.comment.node_idstringrequired
github.event.comment.parent_idinteger or nullrequired
github.event.comment.reactionsobjectrequired
github.event.comment.reactions.+1integerrequired
github.event.comment.reactions.-1integerrequired
github.event.comment.reactions.confusedintegerrequired
github.event.comment.reactions.eyesintegerrequired
github.event.comment.reactions.heartintegerrequired
github.event.comment.reactions.hoorayintegerrequired
github.event.comment.reactions.laughintegerrequired
github.event.comment.reactions.rocketintegerrequired
github.event.comment.reactions.total_countintegerrequired
github.event.comment.reactions.urlstringrequired
github.event.comment.repository_urlstringrequired
github.event.comment.updated_atstringrequired
github.event.comment.userobject or nullrequired
github.event.comment.user.avatar_urlstringoptional
github.event.comment.user.deletedbooleanoptional
github.event.comment.user.emailstring or nulloptional
github.event.comment.user.events_urlstringoptional
github.event.comment.user.followers_urlstringoptional
github.event.comment.user.following_urlstringoptional
github.event.comment.user.gists_urlstringoptional
github.event.comment.user.gravatar_idstringoptional
github.event.comment.user.html_urlstringoptional
github.event.comment.user.idintegerrequired
github.event.comment.user.loginstringrequired
github.event.comment.user.namestringoptional
github.event.comment.user.node_idstringoptional
github.event.comment.user.organizations_urlstringoptional
github.event.comment.user.received_events_urlstringoptional
github.event.comment.user.repos_urlstringoptional
github.event.comment.user.site_adminbooleanoptional
github.event.comment.user.starred_urlstringoptional
github.event.comment.user.subscriptions_urlstringoptional
github.event.comment.user.typeBot, User, Organizationoptional
github.event.comment.user.urlstringoptional
github.event.discussionobjectrequired

A Discussion in a repository.

github.event.discussion.active_lock_reasonstring or nullrequired
github.event.discussion.answer_chosen_atstring or nullrequired
github.event.discussion.answer_chosen_byobject or nullrequired
github.event.discussion.answer_chosen_by.avatar_urlstringoptional
github.event.discussion.answer_chosen_by.deletedbooleanoptional
github.event.discussion.answer_chosen_by.emailstring or nulloptional
github.event.discussion.answer_chosen_by.events_urlstringoptional
github.event.discussion.answer_chosen_by.followers_urlstringoptional
github.event.discussion.answer_chosen_by.following_urlstringoptional
github.event.discussion.answer_chosen_by.gists_urlstringoptional
github.event.discussion.answer_chosen_by.gravatar_idstringoptional
github.event.discussion.answer_chosen_by.html_urlstringoptional
github.event.discussion.answer_chosen_by.idintegerrequired
github.event.discussion.answer_chosen_by.loginstringrequired
github.event.discussion.answer_chosen_by.namestringoptional
github.event.discussion.answer_chosen_by.node_idstringoptional
github.event.discussion.answer_chosen_by.organizations_urlstringoptional
github.event.discussion.answer_chosen_by.received_events_urlstringoptional
github.event.discussion.answer_chosen_by.repos_urlstringoptional
github.event.discussion.answer_chosen_by.site_adminbooleanoptional
github.event.discussion.answer_chosen_by.starred_urlstringoptional
github.event.discussion.answer_chosen_by.subscriptions_urlstringoptional
github.event.discussion.answer_chosen_by.typeBot, User, Organizationoptional
github.event.discussion.answer_chosen_by.urlstringoptional
github.event.discussion.answer_html_urlstring or nullrequired
github.event.discussion.author_associationCOLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERrequired

How the author is associated with the repository.

github.event.discussion.bodystringrequired
github.event.discussion.categoryobjectrequired
github.event.discussion.category.created_atstringrequired
github.event.discussion.category.descriptionstringrequired
github.event.discussion.category.emojistringrequired
github.event.discussion.category.idintegerrequired
github.event.discussion.category.is_answerablebooleanrequired
github.event.discussion.category.namestringrequired
github.event.discussion.category.node_idstringoptional
github.event.discussion.category.repository_idintegerrequired
github.event.discussion.category.slugstringrequired
github.event.discussion.category.updated_atstringrequired
github.event.discussion.commentsintegerrequired
github.event.discussion.created_atstringrequired
github.event.discussion.html_urlstringrequired
github.event.discussion.idintegerrequired
github.event.discussion.lockedbooleanrequired
github.event.discussion.node_idstringrequired
github.event.discussion.numberintegerrequired
github.event.discussion.reactionsobjectoptional
github.event.discussion.reactions.+1integerrequired
github.event.discussion.reactions.-1integerrequired
github.event.discussion.reactions.confusedintegerrequired
github.event.discussion.reactions.eyesintegerrequired
github.event.discussion.reactions.heartintegerrequired
github.event.discussion.reactions.hoorayintegerrequired
github.event.discussion.reactions.laughintegerrequired
github.event.discussion.reactions.rocketintegerrequired
github.event.discussion.reactions.total_countintegerrequired
github.event.discussion.reactions.urlstringrequired
github.event.discussion.repository_urlstringrequired
github.event.discussion.stateopen, closed, locked, converting, transferringrequired

The current state of the discussion. converting means that the discussion is being converted from an issue. transferring means that the discussion is being transferred from another repository.

github.event.discussion.state_reasonresolved, outdated, duplicate, reopened, Nonerequired

The reason for the current state

github.event.discussion.timeline_urlstringoptional
github.event.discussion.titlestringrequired
github.event.discussion.updated_atstringrequired
github.event.discussion.userobject or nullrequired
github.event.discussion.user.avatar_urlstringoptional
github.event.discussion.user.deletedbooleanoptional
github.event.discussion.user.emailstring or nulloptional
github.event.discussion.user.events_urlstringoptional
github.event.discussion.user.followers_urlstringoptional
github.event.discussion.user.following_urlstringoptional
github.event.discussion.user.gists_urlstringoptional
github.event.discussion.user.gravatar_idstringoptional
github.event.discussion.user.html_urlstringoptional
github.event.discussion.user.idintegerrequired
github.event.discussion.user.loginstringrequired
github.event.discussion.user.namestringoptional
github.event.discussion.user.node_idstringoptional
github.event.discussion.user.organizations_urlstringoptional
github.event.discussion.user.received_events_urlstringoptional
github.event.discussion.user.repos_urlstringoptional
github.event.discussion.user.site_adminbooleanoptional
github.event.discussion.user.starred_urlstringoptional
github.event.discussion.user.subscriptions_urlstringoptional
github.event.discussion.user.typeBot, User, Organizationoptional
github.event.discussion.user.urlstringoptional
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.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.

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.

fieldtyperequireddescription
github.event.actioncreatedrequired

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.

fieldtyperequireddescription
github.event.actiondeletedrequired

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.

fieldtyperequireddescription
github.event.actioneditedrequired
github.event.changesobjectrequired
github.event.changes.bodyobjectrequired
github.event.changes.body.fromstringrequired