discussion

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

Github Event discussion #

Github Action Trigger #

source

Webhook event payloadActivity typesGITHUB_SHAGITHUB_REF
discussioncreated
edited
deleted
transferred
pinned
unpinned
labeled
unlabeled
locked
unlocked
category_changed
answered
unanswered
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 discussion in the workflow’s repository is created or modified. For activity related to comments on a discussion, use the discussion_comment 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 has been creatededited, or answered.

on:
  discussion:
    types: [created, edited, answered]

Event Payload #

source

Activities: answered, category_changed, closed, created, deleted, edited, labeled, locked, pinned, reopened, transferred, unanswered, unlabeled, unlocked, unpinned

Common Fields #

These fields are common to every event types available with this trigger.
fieldtyperequireddescription
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.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.repository_urlstringrequired
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.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.

answered #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actionansweredrequired
github.event.answerobjectrequired
github.event.answer.author_associationCOLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERrequired

How the author is associated with the repository.

github.event.answer.bodystringrequired
github.event.answer.child_comment_countintegerrequired
github.event.answer.created_atstringrequired
github.event.answer.discussion_idintegerrequired
github.event.answer.html_urlstringrequired
github.event.answer.idintegerrequired
github.event.answer.node_idstringrequired
github.event.answer.parent_idnullrequired
github.event.answer.reactionsobjectoptional
github.event.answer.reactions.+1integerrequired
github.event.answer.reactions.-1integerrequired
github.event.answer.reactions.confusedintegerrequired
github.event.answer.reactions.eyesintegerrequired
github.event.answer.reactions.heartintegerrequired
github.event.answer.reactions.hoorayintegerrequired
github.event.answer.reactions.laughintegerrequired
github.event.answer.reactions.rocketintegerrequired
github.event.answer.reactions.total_countintegerrequired
github.event.answer.reactions.urlstringrequired
github.event.answer.repository_urlstringrequired
github.event.answer.updated_atstringrequired
github.event.answer.userobject or nullrequired
github.event.answer.user.avatar_urlstringoptional
github.event.answer.user.deletedbooleanoptional
github.event.answer.user.emailstring or nulloptional
github.event.answer.user.events_urlstringoptional
github.event.answer.user.followers_urlstringoptional
github.event.answer.user.following_urlstringoptional
github.event.answer.user.gists_urlstringoptional
github.event.answer.user.gravatar_idstringoptional
github.event.answer.user.html_urlstringoptional
github.event.answer.user.idintegerrequired
github.event.answer.user.loginstringrequired
github.event.answer.user.namestringoptional
github.event.answer.user.node_idstringoptional
github.event.answer.user.organizations_urlstringoptional
github.event.answer.user.received_events_urlstringoptional
github.event.answer.user.repos_urlstringoptional
github.event.answer.user.site_adminbooleanoptional
github.event.answer.user.starred_urlstringoptional
github.event.answer.user.subscriptions_urlstringoptional
github.event.answer.user.typeBot, User, Organizationoptional
github.event.answer.user.urlstringoptional
github.event.discussion.bodystringrequired
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.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.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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

category_changed #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actioncategory_changedrequired
github.event.changesobjectrequired
github.event.changes.categoryobjectrequired
github.event.changes.category.fromobjectrequired
github.event.changes.category.from.created_atstringrequired
github.event.changes.category.from.descriptionstringrequired
github.event.changes.category.from.emojistringrequired
github.event.changes.category.from.idintegerrequired
github.event.changes.category.from.is_answerablebooleanrequired
github.event.changes.category.from.namestringrequired
github.event.changes.category.from.node_idstringoptional
github.event.changes.category.from.repository_idintegerrequired
github.event.changes.category.from.slugstringrequired
github.event.changes.category.from.updated_atstringrequired
github.event.discussion.bodystringrequired
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.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.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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

closed #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actionclosedrequired
github.event.discussion.bodystringrequired
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.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.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.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 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 comment on a discussion, use the discussion_comment 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
github.event.discussion.bodystring or nullrequired
github.event.discussion.reactions.+1integeroptional
github.event.discussion.reactions.-1integeroptional
github.event.discussion.reactions.confusedintegeroptional
github.event.discussion.reactions.eyesintegeroptional
github.event.discussion.reactions.heartintegeroptional
github.event.discussion.reactions.hoorayintegeroptional
github.event.discussion.reactions.laughintegeroptional
github.event.discussion.reactions.rocketintegeroptional
github.event.discussion.reactions.total_countintegeroptional
github.event.discussion.reactions.urlstringoptional
github.event.discussion.stateopen, locked, converting, transferringrequired
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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

deleted #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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
github.event.discussion.bodystringrequired
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.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.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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

edited #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.changesobjectoptional
github.event.changes.bodyobjectoptional
github.event.changes.body.fromstringrequired
github.event.changes.titleobjectoptional
github.event.changes.title.fromstringrequired
github.event.discussion.bodystringrequired
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.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.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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

labeled #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actionlabeledrequired
github.event.discussion.bodystringrequired
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.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.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.labelobjectrequired
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

github.event.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

locked #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actionlockedrequired
github.event.discussion.bodystringrequired
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.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.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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

pinned #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actionpinnedrequired
github.event.discussion.bodystringrequired
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.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.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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

reopened #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actionreopenedrequired
github.event.discussion.bodystringrequired
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.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.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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

transferred #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actiontransferredrequired
github.event.changesobjectrequired
github.event.changes.new_discussionobjectrequired

A Discussion in a repository.

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

How the author is associated with the repository.

github.event.changes.new_discussion.bodystringrequired
github.event.changes.new_discussion.categoryobjectrequired
github.event.changes.new_discussion.category.created_atstringrequired
github.event.changes.new_discussion.category.descriptionstringrequired
github.event.changes.new_discussion.category.emojistringrequired
github.event.changes.new_discussion.category.idintegerrequired
github.event.changes.new_discussion.category.is_answerablebooleanrequired
github.event.changes.new_discussion.category.namestringrequired
github.event.changes.new_discussion.category.node_idstringoptional
github.event.changes.new_discussion.category.repository_idintegerrequired
github.event.changes.new_discussion.category.slugstringrequired
github.event.changes.new_discussion.category.updated_atstringrequired
github.event.changes.new_discussion.commentsintegerrequired
github.event.changes.new_discussion.created_atstringrequired
github.event.changes.new_discussion.html_urlstringrequired
github.event.changes.new_discussion.idintegerrequired
github.event.changes.new_discussion.lockedbooleanrequired
github.event.changes.new_discussion.node_idstringrequired
github.event.changes.new_discussion.numberintegerrequired
github.event.changes.new_discussion.reactionsobjectoptional
github.event.changes.new_discussion.reactions.+1integerrequired
github.event.changes.new_discussion.reactions.-1integerrequired
github.event.changes.new_discussion.reactions.confusedintegerrequired
github.event.changes.new_discussion.reactions.eyesintegerrequired
github.event.changes.new_discussion.reactions.heartintegerrequired
github.event.changes.new_discussion.reactions.hoorayintegerrequired
github.event.changes.new_discussion.reactions.laughintegerrequired
github.event.changes.new_discussion.reactions.rocketintegerrequired
github.event.changes.new_discussion.reactions.total_countintegerrequired
github.event.changes.new_discussion.reactions.urlstringrequired
github.event.changes.new_discussion.repository_urlstringrequired
github.event.changes.new_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.changes.new_discussion.state_reasonresolved, outdated, duplicate, reopened, Nonerequired

The reason for the current state

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

Unique identifier of the repository

github.event.changes.new_repository.node_idstringrequired
github.event.changes.new_repository.namestringrequired

The name of the repository.

github.event.changes.new_repository.full_namestringrequired
github.event.changes.new_repository.licenseobjectrequired

License Simple

github.event.changes.new_repository.license.keystringrequired
github.event.changes.new_repository.license.namestringrequired
github.event.changes.new_repository.license.urlstring or nullrequired
github.event.changes.new_repository.license.spdx_idstring or nullrequired
github.event.changes.new_repository.license.node_idstringrequired
github.event.changes.new_repository.license.html_urlstringoptional
github.event.changes.new_repository.organizationobjectoptional

A GitHub user.

github.event.changes.new_repository.organization.namestring or nulloptional
github.event.changes.new_repository.organization.emailstring or nulloptional
github.event.changes.new_repository.organization.loginstringrequired
github.event.changes.new_repository.organization.idintegerrequired
github.event.changes.new_repository.organization.node_idstringrequired
github.event.changes.new_repository.organization.avatar_urlstringrequired
github.event.changes.new_repository.organization.gravatar_idstring or nullrequired
github.event.changes.new_repository.organization.urlstringrequired
github.event.changes.new_repository.organization.html_urlstringrequired
github.event.changes.new_repository.organization.followers_urlstringrequired
github.event.changes.new_repository.organization.following_urlstringrequired
github.event.changes.new_repository.organization.gists_urlstringrequired
github.event.changes.new_repository.organization.starred_urlstringrequired
github.event.changes.new_repository.organization.subscriptions_urlstringrequired
github.event.changes.new_repository.organization.organizations_urlstringrequired
github.event.changes.new_repository.organization.repos_urlstringrequired
github.event.changes.new_repository.organization.events_urlstringrequired
github.event.changes.new_repository.organization.received_events_urlstringrequired
github.event.changes.new_repository.organization.typestringrequired
github.event.changes.new_repository.organization.site_adminbooleanrequired
github.event.changes.new_repository.organization.starred_atstringoptional
github.event.changes.new_repository.forksintegerrequired
github.event.changes.new_repository.permissionsobjectoptional
github.event.changes.new_repository.permissions.adminbooleanrequired
github.event.changes.new_repository.permissions.pullbooleanrequired
github.event.changes.new_repository.permissions.triagebooleanoptional
github.event.changes.new_repository.permissions.pushbooleanrequired
github.event.changes.new_repository.permissions.maintainbooleanoptional
github.event.changes.new_repository.ownerobjectrequired

A GitHub user.

github.event.changes.new_repository.owner.namestring or nulloptional
github.event.changes.new_repository.owner.emailstring or nulloptional
github.event.changes.new_repository.owner.loginstringrequired
github.event.changes.new_repository.owner.idintegerrequired
github.event.changes.new_repository.owner.node_idstringrequired
github.event.changes.new_repository.owner.avatar_urlstringrequired
github.event.changes.new_repository.owner.gravatar_idstring or nullrequired
github.event.changes.new_repository.owner.urlstringrequired
github.event.changes.new_repository.owner.html_urlstringrequired
github.event.changes.new_repository.owner.followers_urlstringrequired
github.event.changes.new_repository.owner.following_urlstringrequired
github.event.changes.new_repository.owner.gists_urlstringrequired
github.event.changes.new_repository.owner.starred_urlstringrequired
github.event.changes.new_repository.owner.subscriptions_urlstringrequired
github.event.changes.new_repository.owner.organizations_urlstringrequired
github.event.changes.new_repository.owner.repos_urlstringrequired
github.event.changes.new_repository.owner.events_urlstringrequired
github.event.changes.new_repository.owner.received_events_urlstringrequired
github.event.changes.new_repository.owner.typestringrequired
github.event.changes.new_repository.owner.site_adminbooleanrequired
github.event.changes.new_repository.owner.starred_atstringoptional
github.event.changes.new_repository.privatebooleanrequired

Whether the repository is private or public.

github.event.changes.new_repository.html_urlstringrequired
github.event.changes.new_repository.descriptionstring or nullrequired
github.event.changes.new_repository.forkbooleanrequired
github.event.changes.new_repository.urlstringrequired
github.event.changes.new_repository.archive_urlstringrequired
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.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.deployments_urlstringrequired
github.event.changes.new_repository.downloads_urlstringrequired
github.event.changes.new_repository.events_urlstringrequired
github.event.changes.new_repository.forks_urlstringrequired
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.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.languages_urlstringrequired
github.event.changes.new_repository.merges_urlstringrequired
github.event.changes.new_repository.milestones_urlstringrequired
github.event.changes.new_repository.notifications_urlstringrequired
github.event.changes.new_repository.pulls_urlstringrequired
github.event.changes.new_repository.releases_urlstringrequired
github.event.changes.new_repository.ssh_urlstringrequired
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.tags_urlstringrequired
github.event.changes.new_repository.teams_urlstringrequired
github.event.changes.new_repository.trees_urlstringrequired
github.event.changes.new_repository.clone_urlstringrequired
github.event.changes.new_repository.mirror_urlstring or nullrequired
github.event.changes.new_repository.hooks_urlstringrequired
github.event.changes.new_repository.svn_urlstringrequired
github.event.changes.new_repository.homepagestring or nullrequired
github.event.changes.new_repository.languagestring or nullrequired
github.event.changes.new_repository.forks_countintegerrequired
github.event.changes.new_repository.stargazers_countintegerrequired
github.event.changes.new_repository.watchers_countintegerrequired
github.event.changes.new_repository.sizeintegerrequired

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

github.event.changes.new_repository.default_branchstringrequired

The default branch of the repository.

github.event.changes.new_repository.open_issues_countintegerrequired
github.event.changes.new_repository.is_templatebooleanoptional

Whether this repository acts as a template that can be used to generate new repositories.

github.event.changes.new_repository.topicsarray of stringsoptional
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.has_issuesbooleanrequired

Whether issues are enabled.

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_pagesbooleanrequired
github.event.changes.new_repository.has_downloadsbooleanrequired

Whether downloads are enabled.

github.event.changes.new_repository.has_discussionsbooleanoptional

Whether discussions are enabled.

github.event.changes.new_repository.archivedbooleanrequired

Whether the repository is archived.

github.event.changes.new_repository.disabledbooleanrequired

Returns whether or not this repository disabled.

github.event.changes.new_repository.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.changes.new_repository.pushed_atstring or nullrequired
github.event.changes.new_repository.created_atstring or nullrequired
github.event.changes.new_repository.updated_atstring or nullrequired
github.event.changes.new_repository.allow_rebase_mergebooleanoptional

Whether to allow rebase merges for pull requests.

github.event.changes.new_repository.template_repositoryobject or nulloptional
github.event.changes.new_repository.template_repository.idintegeroptional
github.event.changes.new_repository.template_repository.node_idstringoptional
github.event.changes.new_repository.template_repository.namestringoptional
github.event.changes.new_repository.template_repository.full_namestringoptional
github.event.changes.new_repository.template_repository.ownerobjectoptional
github.event.changes.new_repository.template_repository.owner.loginstringoptional
github.event.changes.new_repository.template_repository.owner.idintegeroptional
github.event.changes.new_repository.template_repository.owner.node_idstringoptional
github.event.changes.new_repository.template_repository.owner.avatar_urlstringoptional
github.event.changes.new_repository.template_repository.owner.gravatar_idstringoptional
github.event.changes.new_repository.template_repository.owner.urlstringoptional
github.event.changes.new_repository.template_repository.owner.html_urlstringoptional
github.event.changes.new_repository.template_repository.owner.followers_urlstringoptional
github.event.changes.new_repository.template_repository.owner.following_urlstringoptional
github.event.changes.new_repository.template_repository.owner.gists_urlstringoptional
github.event.changes.new_repository.template_repository.owner.starred_urlstringoptional
github.event.changes.new_repository.template_repository.owner.subscriptions_urlstringoptional
github.event.changes.new_repository.template_repository.owner.organizations_urlstringoptional
github.event.changes.new_repository.template_repository.owner.repos_urlstringoptional
github.event.changes.new_repository.template_repository.owner.events_urlstringoptional
github.event.changes.new_repository.template_repository.owner.received_events_urlstringoptional
github.event.changes.new_repository.template_repository.owner.typestringoptional
github.event.changes.new_repository.template_repository.owner.site_adminbooleanoptional
github.event.changes.new_repository.template_repository.privatebooleanoptional
github.event.changes.new_repository.template_repository.html_urlstringoptional
github.event.changes.new_repository.template_repository.descriptionstringoptional
github.event.changes.new_repository.template_repository.forkbooleanoptional
github.event.changes.new_repository.template_repository.urlstringoptional
github.event.changes.new_repository.template_repository.archive_urlstringoptional
github.event.changes.new_repository.template_repository.assignees_urlstringoptional
github.event.changes.new_repository.template_repository.blobs_urlstringoptional
github.event.changes.new_repository.template_repository.branches_urlstringoptional
github.event.changes.new_repository.template_repository.collaborators_urlstringoptional
github.event.changes.new_repository.template_repository.comments_urlstringoptional
github.event.changes.new_repository.template_repository.commits_urlstringoptional
github.event.changes.new_repository.template_repository.compare_urlstringoptional
github.event.changes.new_repository.template_repository.contents_urlstringoptional
github.event.changes.new_repository.template_repository.contributors_urlstringoptional
github.event.changes.new_repository.template_repository.deployments_urlstringoptional
github.event.changes.new_repository.template_repository.downloads_urlstringoptional
github.event.changes.new_repository.template_repository.events_urlstringoptional
github.event.changes.new_repository.template_repository.forks_urlstringoptional
github.event.changes.new_repository.template_repository.git_commits_urlstringoptional
github.event.changes.new_repository.template_repository.git_refs_urlstringoptional
github.event.changes.new_repository.template_repository.git_tags_urlstringoptional
github.event.changes.new_repository.template_repository.git_urlstringoptional
github.event.changes.new_repository.template_repository.issue_comment_urlstringoptional
github.event.changes.new_repository.template_repository.issue_events_urlstringoptional
github.event.changes.new_repository.template_repository.issues_urlstringoptional
github.event.changes.new_repository.template_repository.keys_urlstringoptional
github.event.changes.new_repository.template_repository.labels_urlstringoptional
github.event.changes.new_repository.template_repository.languages_urlstringoptional
github.event.changes.new_repository.template_repository.merges_urlstringoptional
github.event.changes.new_repository.template_repository.milestones_urlstringoptional
github.event.changes.new_repository.template_repository.notifications_urlstringoptional
github.event.changes.new_repository.template_repository.pulls_urlstringoptional
github.event.changes.new_repository.template_repository.releases_urlstringoptional
github.event.changes.new_repository.template_repository.ssh_urlstringoptional
github.event.changes.new_repository.template_repository.stargazers_urlstringoptional
github.event.changes.new_repository.template_repository.statuses_urlstringoptional
github.event.changes.new_repository.template_repository.subscribers_urlstringoptional
github.event.changes.new_repository.template_repository.subscription_urlstringoptional
github.event.changes.new_repository.template_repository.tags_urlstringoptional
github.event.changes.new_repository.template_repository.teams_urlstringoptional
github.event.changes.new_repository.template_repository.trees_urlstringoptional
github.event.changes.new_repository.template_repository.clone_urlstringoptional
github.event.changes.new_repository.template_repository.mirror_urlstringoptional
github.event.changes.new_repository.template_repository.hooks_urlstringoptional
github.event.changes.new_repository.template_repository.svn_urlstringoptional
github.event.changes.new_repository.template_repository.homepagestringoptional
github.event.changes.new_repository.template_repository.languagestringoptional
github.event.changes.new_repository.template_repository.forks_countintegeroptional
github.event.changes.new_repository.template_repository.stargazers_countintegeroptional
github.event.changes.new_repository.template_repository.watchers_countintegeroptional
github.event.changes.new_repository.template_repository.sizeintegeroptional
github.event.changes.new_repository.template_repository.default_branchstringoptional
github.event.changes.new_repository.template_repository.open_issues_countintegeroptional
github.event.changes.new_repository.template_repository.is_templatebooleanoptional
github.event.changes.new_repository.template_repository.topicsarray of stringsoptional
github.event.changes.new_repository.template_repository.has_issuesbooleanoptional
github.event.changes.new_repository.template_repository.has_projectsbooleanoptional
github.event.changes.new_repository.template_repository.has_wikibooleanoptional
github.event.changes.new_repository.template_repository.has_pagesbooleanoptional
github.event.changes.new_repository.template_repository.has_downloadsbooleanoptional
github.event.changes.new_repository.template_repository.archivedbooleanoptional
github.event.changes.new_repository.template_repository.disabledbooleanoptional
github.event.changes.new_repository.template_repository.visibilitystringoptional
github.event.changes.new_repository.template_repository.pushed_atstringoptional
github.event.changes.new_repository.template_repository.created_atstringoptional
github.event.changes.new_repository.template_repository.updated_atstringoptional
github.event.changes.new_repository.template_repository.permissionsobjectoptional
github.event.changes.new_repository.template_repository.permissions.adminbooleanoptional
github.event.changes.new_repository.template_repository.permissions.maintainbooleanoptional
github.event.changes.new_repository.template_repository.permissions.pushbooleanoptional
github.event.changes.new_repository.template_repository.permissions.triagebooleanoptional
github.event.changes.new_repository.template_repository.permissions.pullbooleanoptional
github.event.changes.new_repository.template_repository.allow_rebase_mergebooleanoptional
github.event.changes.new_repository.template_repository.temp_clone_tokenstringoptional
github.event.changes.new_repository.template_repository.allow_squash_mergebooleanoptional
github.event.changes.new_repository.template_repository.allow_auto_mergebooleanoptional
github.event.changes.new_repository.template_repository.delete_branch_on_mergebooleanoptional
github.event.changes.new_repository.template_repository.allow_update_branchbooleanoptional
github.event.changes.new_repository.template_repository.use_squash_pr_title_as_defaultbooleanoptional
github.event.changes.new_repository.template_repository.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.changes.new_repository.template_repository.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.changes.new_repository.template_repository.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.changes.new_repository.template_repository.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.changes.new_repository.template_repository.allow_merge_commitbooleanoptional
github.event.changes.new_repository.template_repository.subscribers_countintegeroptional
github.event.changes.new_repository.template_repository.network_countintegeroptional
github.event.changes.new_repository.temp_clone_tokenstringoptional
github.event.changes.new_repository.allow_squash_mergebooleanoptional

Whether to allow squash merges for pull requests.

github.event.changes.new_repository.allow_auto_mergebooleanoptional

Whether to allow Auto-merge to be used on pull requests.

github.event.changes.new_repository.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.changes.new_repository.allow_update_branchbooleanoptional

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

github.event.changes.new_repository.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.changes.new_repository.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.changes.new_repository.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.changes.new_repository.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.changes.new_repository.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.changes.new_repository.allow_merge_commitbooleanoptional

Whether to allow merge commits for pull requests.

github.event.changes.new_repository.allow_forkingbooleanoptional

Whether to allow forking this repo

github.event.changes.new_repository.web_commit_signoff_requiredbooleanoptional

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

github.event.changes.new_repository.subscribers_countintegeroptional
github.event.changes.new_repository.network_countintegeroptional
github.event.changes.new_repository.open_issuesintegerrequired
github.event.changes.new_repository.watchersintegerrequired
github.event.changes.new_repository.master_branchstringoptional
github.event.changes.new_repository.starred_atstringoptional
github.event.changes.new_repository.anonymous_access_enabledbooleanoptional

Whether anonymous git access is enabled for this repository

github.event.discussion.bodystringrequired
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.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.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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

unanswered #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actionunansweredrequired
github.event.discussion.bodystringrequired
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.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.old_answerobjectrequired
github.event.old_answer.author_associationCOLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERrequired

How the author is associated with the repository.

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

The GitHub user that triggered the event. This property is included in every webhook payload.

unlabeled #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actionunlabeledrequired
github.event.discussion.bodystringrequired
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.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.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.labelobjectrequired
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

github.event.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

unlocked #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actionunlockedrequired
github.event.discussion.bodystringrequired
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.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.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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

unpinned #

This event occurs when there is activity relating to 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 comment on a discussion, use the discussion_comment 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.actionunpinnedrequired
github.event.discussion.bodystringrequired
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.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.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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.