TypedDict Reference
Generated TypedDict payload classes are the canonical reference for webhook payload fields.
Note
Every generated TypedDict payload is also available as a Pydantic model with the same base name.
For example, IssuesOpenedPayloadDict is available as IssuesOpenedPayload from
github_webhook_types.generated.models.
Pydantic models mirror these generated TypedDict definitions field-for-field and allow unknown
extra fields, matching GitHub's ability to add webhook fields over time.
typed_dicts
TypedDict payloads generated from Octokit's GitHub webhook schema.
Do not edit this module by hand. Run pdm run generate instead.
CheckRunRequestedActionPayloadRequestedActionDict
Bases: TypedDict
The action requested by the user.
CheckRunWithSimpleCheckSuiteOutputDict
Bases: TypedDict
CheckRunWithSimpleCheckSuiteOutput.
CheckSuiteCompletedPayloadCheckSuiteAppPermissionsDict
Bases: TypedDict
The set of permissions for the GitHub app.
CheckSuiteCompletedPayloadCheckSuiteHeadCommitAuthorDict
Bases: TypedDict
Metaproperties for Git author/committer information.
CheckSuiteCompletedPayloadCheckSuiteHeadCommitCommitterDict
Bases: TypedDict
Metaproperties for Git author/committer information.
CheckSuiteCompletedPayloadCheckSuitePullRequestBaseRepoDict
Bases: TypedDict
Repo Ref.
CheckSuiteCompletedPayloadCheckSuitePullRequestHeadRepoDict
Bases: TypedDict
Repo Ref.
CheckSuiteRequestedPayloadCheckSuiteAppPermissionsDict
Bases: TypedDict
The set of permissions for the GitHub app.
CheckSuiteRequestedPayloadCheckSuiteHeadCommitAuthorDict
Bases: TypedDict
Metaproperties for Git author/committer information.
CheckSuiteRequestedPayloadCheckSuiteHeadCommitCommitterDict
Bases: TypedDict
Metaproperties for Git author/committer information.
CheckSuiteRequestedPayloadCheckSuitePullRequestBaseRepoDict
Bases: TypedDict
Repo Ref.
CheckSuiteRequestedPayloadCheckSuitePullRequestHeadRepoDict
Bases: TypedDict
Repo Ref.
CheckSuiteRerequestedPayloadCheckSuiteAppPermissionsDict
Bases: TypedDict
The set of permissions for the GitHub app.
CheckSuiteRerequestedPayloadCheckSuiteHeadCommitAuthorDict
Bases: TypedDict
Metaproperties for Git author/committer information.
CheckSuiteRerequestedPayloadCheckSuiteHeadCommitCommitterDict
Bases: TypedDict
Metaproperties for Git author/committer information.
CheckSuiteRerequestedPayloadCheckSuitePullRequestBaseRepoDict
Bases: TypedDict
Repo Ref.
CheckSuiteRerequestedPayloadCheckSuitePullRequestHeadRepoDict
Bases: TypedDict
Repo Ref.
CodeScanningAlertAppearedInBranchPayloadAlertRuleDict
Bases: TypedDict
CodeScanningAlertAppearedInBranchPayloadAlertRule.
CodeScanningAlertAppearedInBranchPayloadAlertToolDict
Bases: TypedDict
CodeScanningAlertAppearedInBranchPayloadAlertTool.
CodeScanningAlertClosedByUserPayloadAlertRuleDict
Bases: TypedDict
CodeScanningAlertClosedByUserPayloadAlertRule.
CodeScanningAlertClosedByUserPayloadAlertToolDict
Bases: TypedDict
CodeScanningAlertClosedByUserPayloadAlertTool.
CodeScanningAlertCreatedPayloadAlertRuleDict
Bases: TypedDict
CodeScanningAlertCreatedPayloadAlertRule.
CodeScanningAlertFixedPayloadAlertRuleDict
Bases: TypedDict
CodeScanningAlertFixedPayloadAlertRule.
CodeScanningAlertFixedPayloadAlertToolDict
Bases: TypedDict
CodeScanningAlertFixedPayloadAlertTool.
CodeScanningAlertReopenedByUserPayloadAlertRuleDict
Bases: TypedDict
CodeScanningAlertReopenedByUserPayloadAlertRule.
CodeScanningAlertReopenedByUserPayloadAlertToolDict
Bases: TypedDict
CodeScanningAlertReopenedByUserPayloadAlertTool.
CodeScanningAlertReopenedPayloadAlertRuleDict
Bases: TypedDict
CodeScanningAlertReopenedPayloadAlertRule.
CodeScanningAlertReopenedPayloadAlertToolDict
Bases: TypedDict
CodeScanningAlertReopenedPayloadAlertTool.
CustomPropertyDeletedPayloadDefinitionDict
Bases: TypedDict
CustomPropertyDeletedPayloadDefinition.
DependabotAlertSecurityAdvisoryCvssDict
Bases: TypedDict
Details for the advisory pertaining to the Common Vulnerability Scoring System.
DependabotAlertSecurityAdvisoryCweDict
Bases: TypedDict
A CWE weakness assigned to the advisory.
DependabotAlertSecurityAdvisoryIdentifierDict
Bases: TypedDict
An advisory identifier.
DependabotAlertSecurityAdvisoryReferenceDict
Bases: TypedDict
A link to additional advisory information.
DeploymentCreatedPayloadDeploymentDict
DeploymentReviewApprovedPayloadReviewerDict
Bases: TypedDict
DeploymentReviewApprovedPayloadReviewer.
DeploymentReviewApprovedPayloadWorkflowJobRunDict
Bases: TypedDict
DeploymentReviewApprovedPayloadWorkflowJobRun.
DeploymentReviewRejectedPayloadReviewerDict
Bases: TypedDict
DeploymentReviewRejectedPayloadReviewer.
DeploymentReviewRejectedPayloadWorkflowJobRunDict
Bases: TypedDict
DeploymentReviewRejectedPayloadWorkflowJobRun.
DeploymentReviewRequestedPayloadReviewerDict
Bases: TypedDict
DeploymentReviewRequestedPayloadReviewer.
DeploymentReviewRequestedPayloadWorkflowJobRunDict
Bases: TypedDict
DeploymentReviewRequestedPayloadWorkflowJobRun.
DeploymentStatusCreatedPayloadDeploymentDict
DeploymentStatusCreatedPayloadDeploymentStatusDict
DiscussionCategoryDict
Bases: TypedDict
DiscussionCategory.
DiscussionCategoryChangedPayloadChangesCategoryFromDict
Bases: TypedDict
DiscussionCategoryChangedPayloadChangesCategoryFrom.
FullRepositoryPermissionsDict
Bases: TypedDict
FullRepositoryPermissions.
GollumPayloadPageDict
Bases: TypedDict
GollumPayloadPage.
InstallationCreatedPayloadRepositoryDict
Bases: TypedDict
InstallationCreatedPayloadRepository.
InstallationDeletedPayloadRepositoryDict
Bases: TypedDict
InstallationDeletedPayloadRepository.
InstallationNewPermissionsAcceptedPayloadRepositoryDict
Bases: TypedDict
InstallationNewPermissionsAcceptedPayloadRepository.
InstallationRepositoriesAddedPayloadRepositoriesAddedDict
Bases: TypedDict
InstallationRepositoriesAddedPayloadRepositoriesAdded.
InstallationRepositoriesAddedPayloadRepositoriesRemovedDict
Bases: TypedDict
InstallationRepositoriesAddedPayloadRepositoriesRemoved.
InstallationRepositoriesRemovedPayloadRepositoriesAddedDict
Bases: TypedDict
InstallationRepositoriesRemovedPayloadRepositoriesAdded.
InstallationRepositoriesRemovedPayloadRepositoriesRemovedDict
Bases: TypedDict
InstallationRepositoriesRemovedPayloadRepositoriesRemoved.
InstallationSuspendPayloadRepositoryDict
Bases: TypedDict
InstallationSuspendPayloadRepository.
InstallationTargetRenamedPayloadAccountDict
Bases: TypedDict
InstallationTargetRenamedPayloadAccount.
InstallationUnsuspendPayloadRepositoryDict
Bases: TypedDict
InstallationUnsuspendPayloadRepository.
IssueLabelOption2Dict
Bases: TypedDict
IssueLabelOption2.
IssuePullRequestDict
Bases: TypedDict
IssuePullRequest.
IssuesDeletedPayloadIssueLabelDict
Bases: TypedDict
Label.
IssuesDeletedPayloadIssuePullRequestDict
Bases: TypedDict
IssuesDeletedPayloadIssuePullRequest.
IssuesDemilestonedPayloadIssuePullRequestDict
Bases: TypedDict
IssuesDemilestonedPayloadIssuePullRequest.
IssuesEditedPayloadIssueLabelDict
Bases: TypedDict
Label.
IssuesEditedPayloadIssuePullRequestDict
Bases: TypedDict
IssuesEditedPayloadIssuePullRequest.
IssuesLabeledPayloadIssueLabelDict
Bases: TypedDict
Label.
IssuesLabeledPayloadIssuePullRequestDict
Bases: TypedDict
IssuesLabeledPayloadIssuePullRequest.
IssuesLockedPayloadIssuePullRequestDict
Bases: TypedDict
IssuesLockedPayloadIssuePullRequest.
IssuesMilestonedPayloadIssuePullRequestDict
Bases: TypedDict
IssuesMilestonedPayloadIssuePullRequest.
IssuesOpenedPayloadChangesOldRepositoryPermissionsDict
Bases: TypedDict
IssuesOpenedPayloadChangesOldRepositoryPermissions.
IssuesOpenedPayloadIssueLabelDict
Bases: TypedDict
Label.
IssuesOpenedPayloadIssuePullRequestDict
Bases: TypedDict
IssuesOpenedPayloadIssuePullRequest.
IssuesReopenedPayloadIssuePullRequestDict
Bases: TypedDict
IssuesReopenedPayloadIssuePullRequest.
IssuesTransferredPayloadChangesNewIssueLabelDict
Bases: TypedDict
Label.
IssuesTransferredPayloadChangesNewIssuePullRequestDict
Bases: TypedDict
IssuesTransferredPayloadChangesNewIssuePullRequest.
IssuesTransferredPayloadChangesNewRepositoryPermissionsDict
Bases: TypedDict
IssuesTransferredPayloadChangesNewRepositoryPermissions.
IssuesUnlockedPayloadIssuePullRequestDict
Bases: TypedDict
IssuesUnlockedPayloadIssuePullRequest.
MarketplacePurchaseChangedPayloadPreviousMarketplacePurchaseAccountDict
Bases: TypedDict
MarketplacePurchaseChangedPayloadPreviousMarketplacePurchaseAccount.
MarketplacePurchaseChangedPayloadPreviousMarketplacePurchasePlanDict
Bases: TypedDict
MarketplacePurchaseChangedPayloadPreviousMarketplacePurchasePlan.
MarketplacePurchasePendingChangeCancelledPayloadMarketplacePurchaseAccountDict
Bases: TypedDict
MarketplacePurchasePendingChangeCancelledPayloadMarketplacePurchaseAccount.
MarketplacePurchasePendingChangeCancelledPayloadMarketplacePurchasePlanDict
Bases: TypedDict
MarketplacePurchasePendingChangeCancelledPayloadMarketplacePurchasePlan.
MarketplacePurchasePendingChangePayloadPreviousMarketplacePurchaseAccountDict
Bases: TypedDict
MarketplacePurchasePendingChangePayloadPreviousMarketplacePurchaseAccount.
MarketplacePurchasePendingChangePayloadPreviousMarketplacePurchasePlanDict
Bases: TypedDict
MarketplacePurchasePendingChangePayloadPreviousMarketplacePurchasePlan.
MemberAddedPayloadChangesPermissionDict
Bases: TypedDict
This field is included for legacy purposes; use the role_name field instead. The maintain role is mapped to write and the triage role is mapped to read. To determine the role assigned to the collaborator, use the role_name field instead, which will provide the full role name, including custom roles.
MemberAddedPayloadChangesRoleNameDict
Bases: TypedDict
The role assigned to the collaborator.
MetaDeletedPayloadHookConfigDict
Bases: TypedDict
MetaDeletedPayloadHookConfig.
MilestoneClosedPayloadMilestoneDict
Bases: TypedDict
A collection of related issues and pull requests.
MilestoneCreatedPayloadMilestoneDict
Bases: TypedDict
A collection of related issues and pull requests.
MilestoneOpenedPayloadMilestoneDict
Bases: TypedDict
A collection of related issues and pull requests.
MinimalRepositoryPermissionsDict
Bases: TypedDict
MinimalRepositoryPermissions.
OrganizationMemberInvitedPayloadInvitationDict
Bases: TypedDict
The invitation for the user or email if the action is member_invited.
PackagePublishedPayloadPackageDict
Bases: TypedDict
Information about the package.
PackageUpdatedPayloadPackagePackageVersionDockerMetadataDict
Bases: TypedDict
PackageUpdatedPayloadPackagePackageVersionDockerMetadata.
PackageUpdatedPayloadPackagePackageVersionPackageFileDict
Bases: TypedDict
PackageUpdatedPayloadPackagePackageVersionPackageFile.
PackageUpdatedPayloadPackagePackageVersionReleaseDict
Bases: TypedDict
PackageUpdatedPayloadPackagePackageVersionRelease.
PageBuildPayloadBuildErrorDict
Bases: TypedDict
PageBuildPayloadBuildError.
PersonalAccessTokenRequestPermissionsAddedDict
Bases: TypedDict
New requested permissions, categorized by type of permission.
PersonalAccessTokenRequestPermissionsResultDict
Bases: TypedDict
Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.
PersonalAccessTokenRequestPermissionsUpgradedDict
Bases: TypedDict
Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.
PingPayloadHookConfigDict
Bases: TypedDict
PingPayloadHookConfig.
ProjectCardDeletedPayloadProjectCardDict
Bases: TypedDict
Project Card.
PullRequestLabelDict
Bases: TypedDict
PullRequestLabel.
PullRequestAssignedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestAssignedPayloadPullRequestHead.
PullRequestAssignedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestAssignedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestAssignedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestAssignedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestAssignedPayloadPullRequestBaseRepoPermissions.
PullRequestAssignedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestAssignedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestAssignedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestAssignedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestAssignedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestAssignedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestAssignedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestAssignedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestAutoMergeDisabledPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestAutoMergeDisabledPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestAutoMergeDisabledPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestAutoMergeDisabledPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestAutoMergeDisabledPayloadPullRequestBaseRepoPermissions.
PullRequestAutoMergeDisabledPayloadPullRequestHeadRepoPermissionsDict
Bases: TypedDict
PullRequestAutoMergeDisabledPayloadPullRequestHeadRepoPermissions.
PullRequestAutoMergeDisabledPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestAutoMergeDisabledPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestAutoMergeDisabledPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestAutoMergeDisabledPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestAutoMergeDisabledPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestAutoMergeDisabledPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestAutoMergeDisabledPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestAutoMergeDisabledPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestAutoMergeEnabledPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestAutoMergeEnabledPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestAutoMergeEnabledPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestAutoMergeEnabledPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestAutoMergeEnabledPayloadPullRequestBaseRepoPermissions.
PullRequestAutoMergeEnabledPayloadPullRequestHeadRepoPermissionsDict
Bases: TypedDict
PullRequestAutoMergeEnabledPayloadPullRequestHeadRepoPermissions.
PullRequestAutoMergeEnabledPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestAutoMergeEnabledPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestAutoMergeEnabledPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestAutoMergeEnabledPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestAutoMergeEnabledPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestAutoMergeEnabledPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestAutoMergeEnabledPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestAutoMergeEnabledPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestDequeuedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestDequeuedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestDequeuedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestDequeuedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestDequeuedPayloadPullRequestBaseRepoPermissions.
PullRequestDequeuedPayloadPullRequestHeadRepoPermissionsDict
Bases: TypedDict
PullRequestDequeuedPayloadPullRequestHeadRepoPermissions.
PullRequestDequeuedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestDequeuedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestDequeuedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestDequeuedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestDequeuedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestDequeuedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestDequeuedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestDequeuedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestEnqueuedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestEnqueuedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestEnqueuedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestEnqueuedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestEnqueuedPayloadPullRequestBaseRepoPermissions.
PullRequestEnqueuedPayloadPullRequestHeadRepoPermissionsDict
Bases: TypedDict
PullRequestEnqueuedPayloadPullRequestHeadRepoPermissions.
PullRequestEnqueuedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestEnqueuedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestEnqueuedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestEnqueuedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestEnqueuedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestEnqueuedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestEnqueuedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestEnqueuedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestLabeledPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestLabeledPayloadPullRequestHead.
PullRequestLabeledPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestLabeledPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestLabeledPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestLabeledPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestLabeledPayloadPullRequestBaseRepoPermissions.
PullRequestLabeledPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestLabeledPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestLabeledPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestLabeledPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestLabeledPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestLabeledPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestLabeledPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestLabeledPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestLockedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestLockedPayloadPullRequestHead.
PullRequestLockedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestLockedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestLockedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestLockedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestLockedPayloadPullRequestBaseRepoPermissions.
PullRequestLockedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestLockedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestLockedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestLockedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestLockedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestLockedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestLockedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestLockedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestMinimalBaseRepoDict
Bases: TypedDict
PullRequestMinimalBaseRepo.
PullRequestMinimalHeadRepoDict
Bases: TypedDict
PullRequestMinimalHeadRepo.
PullRequestReviewCommentCreatedPayloadCommentLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewCommentCreatedPayloadCommentLinksPullRequestDict
Bases: TypedDict
Link.
PullRequestReviewCommentCreatedPayloadCommentLinksSelfDict
Bases: TypedDict
Link.
PullRequestReviewCommentCreatedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestReviewCommentCreatedPayloadPullRequestHead.
PullRequestReviewCommentCreatedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestReviewCommentCreatedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewCommentCreatedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewCommentCreatedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestReviewCommentCreatedPayloadPullRequestBaseRepoPermissions.
PullRequestReviewCommentCreatedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestReviewCommentCreatedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestReviewCommentCreatedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewCommentCreatedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestReviewCommentCreatedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestReviewCommentCreatedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestReviewCommentCreatedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestReviewCommentCreatedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestReviewCommentDeletedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestReviewCommentDeletedPayloadPullRequestHead.
PullRequestReviewCommentDeletedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestReviewCommentDeletedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewCommentDeletedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewCommentDeletedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestReviewCommentDeletedPayloadPullRequestBaseRepoPermissions.
PullRequestReviewCommentDeletedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestReviewCommentDeletedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestReviewCommentDeletedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewCommentDeletedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestReviewCommentDeletedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestReviewCommentDeletedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestReviewCommentDeletedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestReviewCommentDeletedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestReviewCommentEditedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestReviewCommentEditedPayloadPullRequestHead.
PullRequestReviewCommentEditedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestReviewCommentEditedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewCommentEditedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewCommentEditedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestReviewCommentEditedPayloadPullRequestBaseRepoPermissions.
PullRequestReviewCommentEditedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestReviewCommentEditedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestReviewCommentEditedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewCommentEditedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestReviewCommentEditedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestReviewCommentEditedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestReviewCommentEditedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestReviewCommentEditedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestReviewDismissedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestReviewDismissedPayloadPullRequestHead.
PullRequestReviewDismissedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestReviewDismissedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewDismissedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewDismissedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestReviewDismissedPayloadPullRequestBaseRepoPermissions.
PullRequestReviewDismissedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestReviewDismissedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestReviewDismissedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewDismissedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestReviewDismissedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestReviewDismissedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestReviewDismissedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestReviewDismissedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestReviewDismissedPayloadReviewLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewDismissedPayloadReviewLinksPullRequestDict
Bases: TypedDict
Link.
PullRequestReviewEditedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestReviewEditedPayloadPullRequestHead.
PullRequestReviewEditedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestReviewEditedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewEditedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewEditedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestReviewEditedPayloadPullRequestBaseRepoPermissions.
PullRequestReviewEditedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestReviewEditedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestReviewEditedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewEditedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestReviewEditedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestReviewEditedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestReviewEditedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestReviewEditedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestReviewSubmittedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestReviewSubmittedPayloadPullRequestHead.
PullRequestReviewSubmittedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestReviewSubmittedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewSubmittedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewSubmittedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestReviewSubmittedPayloadPullRequestBaseRepoPermissions.
PullRequestReviewSubmittedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestReviewSubmittedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestReviewSubmittedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewSubmittedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestReviewSubmittedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestReviewSubmittedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestReviewSubmittedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestReviewSubmittedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestReviewThreadResolvedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestReviewThreadResolvedPayloadPullRequestHead.
PullRequestReviewThreadResolvedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestReviewThreadResolvedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewThreadResolvedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewThreadResolvedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestReviewThreadResolvedPayloadPullRequestBaseRepoPermissions.
PullRequestReviewThreadResolvedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestReviewThreadResolvedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestReviewThreadResolvedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewThreadResolvedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestReviewThreadResolvedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestReviewThreadResolvedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestReviewThreadResolvedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestReviewThreadResolvedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestReviewThreadResolvedPayloadThreadCommentLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewThreadResolvedPayloadThreadCommentLinksPullRequestDict
Bases: TypedDict
Link.
PullRequestReviewThreadResolvedPayloadThreadCommentLinksSelfDict
Bases: TypedDict
Link.
PullRequestReviewThreadUnresolvedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestReviewThreadUnresolvedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewThreadUnresolvedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestReviewThreadUnresolvedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestReviewThreadUnresolvedPayloadPullRequestBaseRepoPermissions.
PullRequestReviewThreadUnresolvedPayloadPullRequestHeadRepoPermissionsDict
Bases: TypedDict
PullRequestReviewThreadUnresolvedPayloadPullRequestHeadRepoPermissions.
PullRequestReviewThreadUnresolvedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestReviewThreadUnresolvedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestReviewThreadUnresolvedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewThreadUnresolvedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestReviewThreadUnresolvedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestReviewThreadUnresolvedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestReviewThreadUnresolvedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestReviewThreadUnresolvedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestReviewThreadUnresolvedPayloadThreadCommentLinksHtmlDict
Bases: TypedDict
Link.
PullRequestReviewThreadUnresolvedPayloadThreadCommentLinksPullRequestDict
Bases: TypedDict
Link.
PullRequestReviewThreadUnresolvedPayloadThreadCommentLinksSelfDict
Bases: TypedDict
Link.
PullRequestSynchronizePayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestSynchronizePayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestSynchronizePayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestSynchronizePayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestSynchronizePayloadPullRequestBaseRepoPermissions.
PullRequestSynchronizePayloadPullRequestHeadRepoPermissionsDict
Bases: TypedDict
PullRequestSynchronizePayloadPullRequestHeadRepoPermissions.
PullRequestSynchronizePayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestSynchronizePayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestSynchronizePayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestSynchronizePayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestSynchronizePayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestSynchronizePayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestSynchronizePayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestSynchronizePayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestUnassignedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestUnassignedPayloadPullRequestHead.
PullRequestUnassignedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestUnassignedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestUnassignedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestUnassignedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestUnassignedPayloadPullRequestBaseRepoPermissions.
PullRequestUnassignedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestUnassignedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestUnassignedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestUnassignedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestUnassignedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestUnassignedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestUnassignedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestUnassignedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestUnlabeledPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestUnlabeledPayloadPullRequestHead.
PullRequestUnlabeledPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestUnlabeledPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestUnlabeledPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestUnlabeledPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestUnlabeledPayloadPullRequestBaseRepoPermissions.
PullRequestUnlabeledPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestUnlabeledPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestUnlabeledPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestUnlabeledPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestUnlabeledPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestUnlabeledPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestUnlabeledPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestUnlabeledPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PullRequestUnlockedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestUnlockedPayloadPullRequestHead.
PullRequestUnlockedPayloadPullRequestLabelDict
Bases: TypedDict
Label.
PullRequestUnlockedPayloadPullRequestRequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestUnlockedPayloadPullRequestRequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
PullRequestUnlockedPayloadPullRequestBaseRepoPermissionsDict
Bases: TypedDict
PullRequestUnlockedPayloadPullRequestBaseRepoPermissions.
PullRequestUnlockedPayloadPullRequestLinksCommentsDict
Bases: TypedDict
Link.
PullRequestUnlockedPayloadPullRequestLinksCommitsDict
Bases: TypedDict
Link.
PullRequestUnlockedPayloadPullRequestLinksHtmlDict
Bases: TypedDict
Link.
PullRequestUnlockedPayloadPullRequestLinksIssueDict
Bases: TypedDict
Link.
PullRequestUnlockedPayloadPullRequestLinksReviewCommentDict
Bases: TypedDict
Link.
PullRequestUnlockedPayloadPullRequestLinksReviewCommentsDict
Bases: TypedDict
Link.
PullRequestUnlockedPayloadPullRequestLinksSelfDict
Bases: TypedDict
Link.
PullRequestUnlockedPayloadPullRequestLinksStatusesDict
Bases: TypedDict
Link.
PushPayloadPusherDict
Bases: TypedDict
Metaproperties for Git author/committer information.
PushPayloadCommitAuthorDict
Bases: TypedDict
Metaproperties for Git author/committer information.
PushPayloadCommitCommitterDict
Bases: TypedDict
Metaproperties for Git author/committer information.
PushPayloadRepositoryPermissionsDict
Bases: TypedDict
PushPayloadRepositoryPermissions.
RegistryPackagePublishedPayloadRegistryPackageOwnerDict
Bases: TypedDict
RegistryPackagePublishedPayloadRegistryPackageOwner.
RegistryPackageUpdatedPayloadRegistryPackageOwnerDict
Bases: TypedDict
RegistryPackageUpdatedPayloadRegistryPackageOwner.
RegistryPackageUpdatedPayloadRegistryPackagePackageVersionAuthorDict
Bases: TypedDict
RegistryPackageUpdatedPayloadRegistryPackagePackageVersionAuthor.
RegistryPackageUpdatedPayloadRegistryPackagePackageVersionPackageFileDict
Bases: TypedDict
RegistryPackageUpdatedPayloadRegistryPackagePackageVersionPackageFile.
RegistryPackageUpdatedPayloadRegistryPackagePackageVersionReleaseAuthorDict
Bases: TypedDict
RegistryPackageUpdatedPayloadRegistryPackagePackageVersionReleaseAuthor.
ReleaseEditedPayloadChangesMakeLatestDict
Bases: TypedDict
ReleaseEditedPayloadChangesMakeLatest.
Repository2CodeSearchIndexStatusDict
Bases: TypedDict
The status of the code search index for this repository.
Repository2PermissionsDict
Bases: TypedDict
Repository2Permissions.
RepositoryPermissionsDict
Bases: TypedDict
RepositoryPermissions.
RepositoryAdvisoryIdentifierDict
Bases: TypedDict
RepositoryAdvisoryIdentifier.
RepositoryRuleBranchNamePatternParametersDict
Bases: TypedDict
RepositoryRuleBranchNamePatternParameters.
RepositoryRuleCommitAuthorEmailPatternParametersDict
Bases: TypedDict
RepositoryRuleCommitAuthorEmailPatternParameters.
RepositoryRuleCommitMessagePatternParametersDict
Bases: TypedDict
RepositoryRuleCommitMessagePatternParameters.
RepositoryRuleCommitterEmailPatternParametersDict
Bases: TypedDict
RepositoryRuleCommitterEmailPatternParameters.
RepositoryRuleCopilotCodeReviewParametersDict
Bases: TypedDict
RepositoryRuleCopilotCodeReviewParameters.
RepositoryRuleFileExtensionRestrictionParametersDict
Bases: TypedDict
RepositoryRuleFileExtensionRestrictionParameters.
RepositoryRuleFilePathRestrictionParametersDict
Bases: TypedDict
RepositoryRuleFilePathRestrictionParameters.
RepositoryRuleMaxFilePathLengthParametersDict
Bases: TypedDict
RepositoryRuleMaxFilePathLengthParameters.
RepositoryRuleMaxFileSizeParametersDict
Bases: TypedDict
RepositoryRuleMaxFileSizeParameters.
RepositoryRuleMergeQueueParametersDict
Bases: TypedDict
RepositoryRuleMergeQueueParameters.
RepositoryRuleRequiredDeploymentsParametersDict
Bases: TypedDict
RepositoryRuleRequiredDeploymentsParameters.
RepositoryRuleTagNamePatternParametersDict
Bases: TypedDict
RepositoryRuleTagNamePatternParameters.
RepositoryRuleUpdateParametersDict
Bases: TypedDict
RepositoryRuleUpdateParameters.
RepositoryRulesetConditionsRefNameDict
Bases: TypedDict
RepositoryRulesetConditionsRefName.
RepositoryRulesetLinksSelfDict
Bases: TypedDict
RepositoryRulesetLinksSelf.
RepositoryTransferredPayloadChangesOwnerFromOrganizationDict
Bases: TypedDict
Organization.
RepositoryVulnerabilityAlertDismissPayloadAlertDict
Bases: TypedDict
The security alert of the vulnerable dependency.
RepositoryVulnerabilityAlertResolvePayloadAlertDict
Bases: TypedDict
The security alert of the vulnerable dependency.
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryCvssDict
Bases: TypedDict
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryCvss.
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryCweDict
Bases: TypedDict
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryCwe.
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryIdentifierDict
Bases: TypedDict
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryIdentifier.
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryReferenceDict
Bases: TypedDict
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryReference.
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryVulnerabilityPackageDict
Bases: TypedDict
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryVulnerabilityPackage.
SecurityAndAnalysisPayloadChangesFromDict
Bases: TypedDict
SecurityAndAnalysisPayloadChangesFrom.
StatusPayloadBrancheCommitDict
Bases: TypedDict
StatusPayloadBrancheCommit.
StatusPayloadCommitParentDict
Bases: TypedDict
StatusPayloadCommitParent.
StatusPayloadCommitCommitTreeDict
Bases: TypedDict
StatusPayloadCommitCommitTree.
StatusPayloadCommitCommitVerificationDict
Bases: TypedDict
StatusPayloadCommitCommitVerification.
TeamAddedToRepositoryPayloadRepositoryPermissionsDict
Bases: TypedDict
TeamAddedToRepositoryPayloadRepositoryPermissions.
TeamCreatedPayloadRepositoryPermissionsDict
Bases: TypedDict
TeamCreatedPayloadRepositoryPermissions.
TeamDeletedPayloadRepositoryPermissionsDict
Bases: TypedDict
TeamDeletedPayloadRepositoryPermissions.
TeamEditedPayloadChangesRepositoryPermissionsFromDict
Bases: TypedDict
TeamEditedPayloadChangesRepositoryPermissionsFrom.
TeamEditedPayloadRepositoryPermissionsDict
Bases: TypedDict
TeamEditedPayloadRepositoryPermissions.
TeamRemovedFromRepositoryPayloadRepositoryPermissionsDict
Bases: TypedDict
TeamRemovedFromRepositoryPayloadRepositoryPermissions.
WebhookRubygemsMetadataVersionInfoDict
Bases: TypedDict
WebhookRubygemsMetadataVersionInfo.
WebhooksChanges8TierFromDict
Bases: TypedDict
The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
WebhooksIssue2LabelDict
Bases: TypedDict
Label.
WebhooksIssue2PullRequestDict
Bases: TypedDict
WebhooksIssue2PullRequest.
WebhooksIssueLabelDict
Bases: TypedDict
Label.
WebhooksIssuePullRequestDict
Bases: TypedDict
WebhooksIssuePullRequest.
WebhooksMarketplacePurchaseAccountDict
Bases: TypedDict
WebhooksMarketplacePurchaseAccount.
WebhooksMarketplacePurchasePlanDict
Bases: TypedDict
WebhooksMarketplacePurchasePlan.
WebhooksPreviousMarketplacePurchaseAccountDict
Bases: TypedDict
WebhooksPreviousMarketplacePurchaseAccount.
WebhooksPreviousMarketplacePurchasePlanDict
Bases: TypedDict
WebhooksPreviousMarketplacePurchasePlan.
WebhooksPullRequest5LabelDict
Bases: TypedDict
Label.
WebhooksPullRequest5RequestedReviewerOption2Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
WebhooksPullRequest5RequestedTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
WebhooksPullRequest5BaseRepoPermissionsDict
Bases: TypedDict
WebhooksPullRequest5BaseRepoPermissions.
WebhooksPullRequest5HeadRepoPermissionsDict
Bases: TypedDict
WebhooksPullRequest5HeadRepoPermissions.
WebhooksPullRequest5LinksCommentsDict
Bases: TypedDict
Link.
WebhooksPullRequest5LinksCommitsDict
Bases: TypedDict
Link.
WebhooksPullRequest5LinksHtmlDict
Bases: TypedDict
Link.
WebhooksPullRequest5LinksIssueDict
Bases: TypedDict
Link.
WebhooksPullRequest5LinksReviewCommentDict
Bases: TypedDict
Link.
WebhooksPullRequest5LinksReviewCommentsDict
Bases: TypedDict
Link.
WebhooksPullRequest5LinksSelfDict
Bases: TypedDict
Link.
WebhooksPullRequest5LinksStatusesDict
Bases: TypedDict
Link.
WebhooksReleaseAssetDict
Bases: TypedDict
Data related to a release.
WebhooksReviewCommentLinksHtmlDict
Bases: TypedDict
Link.
WebhooksReviewCommentLinksPullRequestDict
Bases: TypedDict
Link.
WebhooksReviewCommentLinksSelfDict
Bases: TypedDict
Link.
WebhooksReviewLinksHtmlDict
Bases: TypedDict
Link.
WebhooksReviewLinksPullRequestDict
Bases: TypedDict
Link.
WebhooksSecurityAdvisoryCvssDict
Bases: TypedDict
WebhooksSecurityAdvisoryCvss.
WebhooksSecurityAdvisoryCweDict
Bases: TypedDict
WebhooksSecurityAdvisoryCwe.
WebhooksSecurityAdvisoryIdentifierDict
Bases: TypedDict
WebhooksSecurityAdvisoryIdentifier.
WebhooksSecurityAdvisoryReferenceDict
Bases: TypedDict
WebhooksSecurityAdvisoryReference.
WebhooksSecurityAdvisoryVulnerabilityPackageDict
Bases: TypedDict
WebhooksSecurityAdvisoryVulnerabilityPackage.
WebhooksSponsorshipMaintainerDict
Bases: TypedDict
WebhooksSponsorshipMaintainer.
WebhooksSponsorshipTierDict
Bases: TypedDict
The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
WorkflowJobQueuedPayloadWorkflowJobStepDict
Bases: TypedDict
Workflow Step.
WorkflowJobWaitingPayloadWorkflowJobStepDict
Bases: TypedDict
Workflow Step.
WorkflowRunCompletedPayloadWorkflowRunHeadRepositoryDict
Bases: TypedDict
Repository Lite.
WorkflowRunCompletedPayloadWorkflowRunRepositoryDict
Bases: TypedDict
Repository Lite.
WorkflowRunCompletedPayloadWorkflowRunHeadCommitAuthorDict
Bases: TypedDict
Metaproperties for Git author/committer information.
WorkflowRunCompletedPayloadWorkflowRunHeadCommitCommitterDict
Bases: TypedDict
Metaproperties for Git author/committer information.
WorkflowRunInProgressPayloadWorkflowRunHeadRepositoryDict
Bases: TypedDict
Repository Lite.
WorkflowRunInProgressPayloadWorkflowRunRepositoryDict
Bases: TypedDict
Repository Lite.
WorkflowRunInProgressPayloadWorkflowRunHeadCommitAuthorDict
Bases: TypedDict
Metaproperties for Git author/committer information.
WorkflowRunInProgressPayloadWorkflowRunHeadCommitCommitterDict
Bases: TypedDict
Metaproperties for Git author/committer information.
WorkflowRunRequestedPayloadWorkflowRunHeadRepositoryDict
Bases: TypedDict
Repository Lite.
WorkflowRunRequestedPayloadWorkflowRunRepositoryDict
Bases: TypedDict
Repository Lite.
WorkflowRunRequestedPayloadWorkflowRunHeadCommitAuthorDict
Bases: TypedDict
Metaproperties for Git author/committer information.
WorkflowRunRequestedPayloadWorkflowRunHeadCommitCommitterDict
Bases: TypedDict
Metaproperties for Git author/committer information.
WorkflowRunRequestedPayloadWorkflowRunPullRequestBaseRepoDict
Bases: TypedDict
Repo Ref.
WorkflowRunRequestedPayloadWorkflowRunPullRequestHeadRepoDict
Bases: TypedDict
Repo Ref.
AppPermissionsDict
Bases: TypedDict
The permissions granted to the user access token.
CodeOfConductDict
Bases: TypedDict
Code Of Conduct.
CodeOfConductSimpleDict
Bases: TypedDict
Code of Conduct Simple.
CustomPropertyDict
Bases: TypedDict
Custom property defined on an organization.
CustomPropertyValueDict
Bases: TypedDict
Custom property name and associated value.
DependabotAlertPackageDict
Bases: TypedDict
Details for the vulnerable package.
DeploymentSimpleDict
Bases: TypedDict
A deployment created as the result of an Actions check run from a workflow that references an environment.
EnterpriseDict2
Bases: TypedDict
An enterprise on GitHub.
EnterpriseDict
Bases: TypedDict
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.
HookResponseDict
Bases: TypedDict
Hook Response.
IssueDependenciesSummaryDict
Bases: TypedDict
Issue Dependencies Summary.
IssueFieldValueDict
Bases: TypedDict
A value assigned to an issue field.
LabelDict
Bases: TypedDict
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
LicenseSimpleDict
Bases: TypedDict
License Simple.
LinkDict
Bases: TypedDict
Hypermedia Link.
OrganizationDict
Bases: TypedDict
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.
ProjectsV2IterationSettingDict
Bases: TypedDict
An iteration setting for an iteration field.
ProjectsV2SingleSelectOptionDict
Bases: TypedDict
An option for a single select field.
RepositoryRuleCreationDict
Bases: TypedDict
Only allow users with bypass permission to create matching refs.
RepositoryRuleDeletionDict
Bases: TypedDict
Only allow users with bypass permissions to delete matching refs.
RepositoryRuleNonFastForwardDict
Bases: TypedDict
Prevent users with push access from force pushing to refs.
RepositoryRuleParamsCodeScanningToolDict
Bases: TypedDict
A tool that must provide code scanning results for this rule to pass.
RepositoryRuleParamsReviewerDict
Bases: TypedDict
A required reviewing team.
RepositoryRuleParamsStatusCheckConfigurationDict
Bases: TypedDict
Required status check.
RepositoryRuleParamsWorkflowFileReferenceDict
Bases: TypedDict
A workflow that must run for this rule to pass.
RepositoryRuleRequiredLinearHistoryDict
Bases: TypedDict
Prevent merge commits from being pushed to matching refs.
RepositoryRuleRequiredSignaturesDict
Bases: TypedDict
Commits pushed to matching refs must have verified signatures.
RepositoryRulesetBypassActorDict
Bases: TypedDict
An actor that can bypass rules in a ruleset.
SecretScanningLocationCommitDict
Bases: TypedDict
Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
SecretScanningLocationDiscussionBodyDict
Bases: TypedDict
Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.
SecretScanningLocationDiscussionCommentDict
Bases: TypedDict
Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.
SecretScanningLocationDiscussionTitleDict
Bases: TypedDict
Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.
SecretScanningLocationIssueBodyDict
Bases: TypedDict
Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
SecretScanningLocationIssueCommentDict
Bases: TypedDict
Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
SecretScanningLocationIssueTitleDict
Bases: TypedDict
Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
SecretScanningLocationPullRequestBodyDict
Bases: TypedDict
Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.
SecretScanningLocationPullRequestCommentDict
Bases: TypedDict
Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.
SecretScanningLocationPullRequestReviewDict
Bases: TypedDict
Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.
SecretScanningLocationPullRequestReviewCommentDict
Bases: TypedDict
Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.
SecretScanningLocationPullRequestTitleDict
Bases: TypedDict
Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.
SecretScanningLocationWikiCommitDict
Bases: TypedDict
Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.
SimpleCommitDict
Bases: TypedDict
A commit.
InstallationDict
Bases: TypedDict
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.
UserDict
Bases: TypedDict
A GitHub user.
SubIssuesSummaryDict
Bases: TypedDict
Sub-issues Summary.
PullRequestPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook.
PullRequestPayloadDict2
Bases: TypedDict
Payload for the GitHub pull_request webhook.
WebhooksAlertDict
Bases: TypedDict
The security alert of the vulnerable dependency.
WebhooksApproverDict
Bases: TypedDict
WebhooksApprover.
WebhooksDeployKeyDict
WebhooksLabelDict
Bases: TypedDict
Label.
WebhooksMembershipDict
Bases: TypedDict
The membership between the user and the organization. Not present when the action is member_invited.
WebhooksMilestoneDict
Bases: TypedDict
A collection of related issues and pull requests.
WebhooksProjectDict
Bases: TypedDict
Project.
WebhooksProjectCardDict
Bases: TypedDict
Project Card.
WebhooksProjectColumnDict
Bases: TypedDict
Project Column.
WebhooksRuleDict
Bases: TypedDict
The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
WebhooksTeamDict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
WebhooksTeam1Dict
Bases: TypedDict
Groups of organization members that gives permissions on specified repositories.
WebhooksWorkflowJobRunDict
Bases: TypedDict
WebhooksWorkflowJobRun.
BranchProtectionRuleEditedPayloadChangesDict
Bases: TypedDict
If the action was edited, the changes to the rule.
CheckSuiteCompletedPayloadCheckSuiteAppDict
Bases: TypedDict
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
CheckSuiteCompletedPayloadCheckSuiteHeadCommitDict
Bases: TypedDict
SimpleCommit.
CheckSuiteCompletedPayloadCheckSuitePullRequestBaseDict
Bases: TypedDict
CheckSuiteCompletedPayloadCheckSuitePullRequestBase.
CheckSuiteCompletedPayloadCheckSuitePullRequestHeadDict
Bases: TypedDict
CheckSuiteCompletedPayloadCheckSuitePullRequestHead.
CheckSuiteRequestedPayloadCheckSuiteAppDict
Bases: TypedDict
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
CheckSuiteRequestedPayloadCheckSuiteHeadCommitDict
Bases: TypedDict
SimpleCommit.
CheckSuiteRequestedPayloadCheckSuitePullRequestBaseDict
Bases: TypedDict
CheckSuiteRequestedPayloadCheckSuitePullRequestBase.
CheckSuiteRequestedPayloadCheckSuitePullRequestHeadDict
Bases: TypedDict
CheckSuiteRequestedPayloadCheckSuitePullRequestHead.
CheckSuiteRerequestedPayloadCheckSuiteAppDict
Bases: TypedDict
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
CheckSuiteRerequestedPayloadCheckSuiteHeadCommitDict
Bases: TypedDict
SimpleCommit.
CheckSuiteRerequestedPayloadCheckSuitePullRequestBaseDict
Bases: TypedDict
CheckSuiteRerequestedPayloadCheckSuitePullRequestBase.
CheckSuiteRerequestedPayloadCheckSuitePullRequestHeadDict
Bases: TypedDict
CheckSuiteRerequestedPayloadCheckSuitePullRequestHead.
CommitCommentCreatedPayloadCommentDict
DiscussionCommentEditedPayloadChangesDict
Bases: TypedDict
DiscussionCommentEditedPayloadChanges.
DiscussionEditedPayloadChangesDict
Bases: TypedDict
DiscussionEditedPayloadChanges.
InstallationTargetRenamedPayloadChangesDict
Bases: TypedDict
InstallationTargetRenamedPayloadChanges.
IssueCommentCreatedPayloadCommentDict
IssuesEditedPayloadChangesDict
Bases: TypedDict
The changes to the issue.
IssuesOpenedPayloadChangesOldRepositoryDict
Bases: TypedDict
A git repository.
IssuesTransferredPayloadChangesNewRepositoryDict
Bases: TypedDict
A git repository.
LabelEditedPayloadChangesDict
Bases: TypedDict
The changes to the label if the action was edited.
MarketplacePurchaseChangedPayloadPreviousMarketplacePurchaseDict
Bases: TypedDict
Marketplace Purchase.
MarketplacePurchasePendingChangeCancelledPayloadMarketplacePurchaseDict
Bases: TypedDict
Marketplace Purchase.
MarketplacePurchasePendingChangePayloadPreviousMarketplacePurchaseDict
Bases: TypedDict
Marketplace Purchase.
MemberAddedPayloadChangesDict
Bases: TypedDict
MemberAddedPayloadChanges.
MemberEditedPayloadChangesDict
Bases: TypedDict
The changes to the collaborator permissions.
MetaDeletedPayloadHookDict
Bases: TypedDict
The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.
MilestoneEditedPayloadChangesDict
Bases: TypedDict
The changes to the milestone if the action was edited.
OrganizationRenamedPayloadChangesDict
Bases: TypedDict
OrganizationRenamedPayloadChanges.
PageBuildPayloadBuildDict
ProjectCardConvertedPayloadChangesDict
Bases: TypedDict
ProjectCardConvertedPayloadChanges.
ProjectCardEditedPayloadChangesDict
Bases: TypedDict
ProjectCardEditedPayloadChanges.
ProjectCardMovedPayloadChangesDict
Bases: TypedDict
ProjectCardMovedPayloadChanges.
ProjectColumnEditedPayloadChangesDict
Bases: TypedDict
ProjectColumnEditedPayloadChanges.
ProjectEditedPayloadChangesDict
Bases: TypedDict
The changes to the project if the action was edited.
ProjectsV2EditedPayloadChangesDict
Bases: TypedDict
ProjectsV2EditedPayloadChanges.
ProjectsV2ItemConvertedPayloadChangesDict
Bases: TypedDict
ProjectsV2ItemConvertedPayloadChanges.
ProjectsV2ItemEditedPayloadChangesOption2Dict
Bases: TypedDict
ProjectsV2ItemEditedPayloadChangesOption2.
ProjectsV2ItemReorderedPayloadChangesDict
Bases: TypedDict
ProjectsV2ItemReorderedPayloadChanges.
ProjectsV2StatusUpdateEditedPayloadChangesDict
Bases: TypedDict
ProjectsV2StatusUpdateEditedPayloadChanges.
PullRequestAssignedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestAssignedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestAssignedPayloadPullRequestLinks.
PullRequestAutoMergeDisabledPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestAutoMergeDisabledPayloadPullRequestHeadRepoDict
Bases: TypedDict
A git repository.
PullRequestAutoMergeDisabledPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestAutoMergeDisabledPayloadPullRequestLinks.
PullRequestAutoMergeEnabledPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestAutoMergeEnabledPayloadPullRequestHeadRepoDict
Bases: TypedDict
A git repository.
PullRequestAutoMergeEnabledPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestAutoMergeEnabledPayloadPullRequestLinks.
PullRequestDequeuedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestDequeuedPayloadPullRequestHeadRepoDict
Bases: TypedDict
A git repository.
PullRequestDequeuedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestDequeuedPayloadPullRequestLinks.
PullRequestEditedPayloadChangesBaseDict
Bases: TypedDict
PullRequestEditedPayloadChangesBase.
PullRequestEnqueuedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestEnqueuedPayloadPullRequestHeadRepoDict
Bases: TypedDict
A git repository.
PullRequestEnqueuedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestEnqueuedPayloadPullRequestLinks.
PullRequestLabeledPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestLabeledPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestLabeledPayloadPullRequestLinks.
PullRequestLockedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestLockedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestLockedPayloadPullRequestLinks.
PullRequestMinimalBaseDict
Bases: TypedDict
PullRequestMinimalBase.
PullRequestMinimalHeadDict
Bases: TypedDict
PullRequestMinimalHead.
PullRequestReviewCommentCreatedPayloadCommentLinksDict
Bases: TypedDict
PullRequestReviewCommentCreatedPayloadCommentLinks.
PullRequestReviewCommentCreatedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestReviewCommentCreatedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestReviewCommentCreatedPayloadPullRequestLinks.
PullRequestReviewCommentDeletedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestReviewCommentDeletedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestReviewCommentDeletedPayloadPullRequestLinks.
PullRequestReviewCommentEditedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestReviewCommentEditedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestReviewCommentEditedPayloadPullRequestLinks.
PullRequestReviewDismissedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestReviewDismissedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestReviewDismissedPayloadPullRequestLinks.
PullRequestReviewDismissedPayloadReviewLinksDict
Bases: TypedDict
PullRequestReviewDismissedPayloadReviewLinks.
PullRequestReviewEditedPayloadChangesDict
Bases: TypedDict
PullRequestReviewEditedPayloadChanges.
PullRequestReviewEditedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestReviewEditedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestReviewEditedPayloadPullRequestLinks.
PullRequestReviewSubmittedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestReviewSubmittedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestReviewSubmittedPayloadPullRequestLinks.
PullRequestReviewThreadResolvedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestReviewThreadResolvedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestReviewThreadResolvedPayloadPullRequestLinks.
PullRequestReviewThreadResolvedPayloadThreadCommentLinksDict
Bases: TypedDict
PullRequestReviewThreadResolvedPayloadThreadCommentLinks.
PullRequestReviewThreadUnresolvedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestReviewThreadUnresolvedPayloadPullRequestHeadRepoDict
Bases: TypedDict
A git repository.
PullRequestReviewThreadUnresolvedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestReviewThreadUnresolvedPayloadPullRequestLinks.
PullRequestReviewThreadUnresolvedPayloadThreadCommentLinksDict
Bases: TypedDict
PullRequestReviewThreadUnresolvedPayloadThreadCommentLinks.
PullRequestSynchronizePayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestSynchronizePayloadPullRequestHeadRepoDict
Bases: TypedDict
A git repository.
PullRequestSynchronizePayloadPullRequestLinksDict
Bases: TypedDict
PullRequestSynchronizePayloadPullRequestLinks.
PullRequestUnassignedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestUnassignedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestUnassignedPayloadPullRequestLinks.
PullRequestUnlabeledPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestUnlabeledPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestUnlabeledPayloadPullRequestLinks.
PullRequestUnlockedPayloadPullRequestBaseRepoDict
Bases: TypedDict
A git repository.
PullRequestUnlockedPayloadPullRequestLinksDict
Bases: TypedDict
PullRequestUnlockedPayloadPullRequestLinks.
PushPayloadCommitDict
Bases: TypedDict
Commit.
PushPayloadRepositoryDict
Bases: TypedDict
A git repository.
RegistryPackagePublishedPayloadRegistryPackageDict
Bases: TypedDict
RegistryPackagePublishedPayloadRegistryPackage.
RegistryPackageUpdatedPayloadRegistryPackagePackageVersionReleaseDict
Bases: TypedDict
RegistryPackageUpdatedPayloadRegistryPackagePackageVersionRelease.
ReleaseEditedPayloadChangesDict
Bases: TypedDict
ReleaseEditedPayloadChanges.
ReleasePrereleasedPayloadReleaseDict
RepositoryAdvisoryDict
Bases: TypedDict
A repository security advisory.
RepositoryEditedPayloadChangesDict
Bases: TypedDict
RepositoryEditedPayloadChanges.
RepositoryRenamedPayloadChangesRepositoryDict
Bases: TypedDict
RepositoryRenamedPayloadChangesRepository.
RepositoryRuleBranchNamePatternDict
Bases: TypedDict
Parameters to be used for the branch_name_pattern rule.
RepositoryRuleCommitAuthorEmailPatternDict
Bases: TypedDict
Parameters to be used for the commit_author_email_pattern rule.
RepositoryRuleCommitMessagePatternDict
Bases: TypedDict
Parameters to be used for the commit_message_pattern rule.
RepositoryRuleCommitterEmailPatternDict
Bases: TypedDict
Parameters to be used for the committer_email_pattern rule.
RepositoryRuleCopilotCodeReviewDict
Bases: TypedDict
Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
RepositoryRuleFileExtensionRestrictionDict
Bases: TypedDict
Prevent commits that include files with specified file extensions from being pushed to the commit graph.
RepositoryRuleFilePathRestrictionDict
Bases: TypedDict
Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.
RepositoryRuleMaxFilePathLengthDict
Bases: TypedDict
Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.
RepositoryRuleMaxFileSizeDict
Bases: TypedDict
Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.
RepositoryRuleMergeQueueDict
Bases: TypedDict
Merges must be performed via a merge queue.
RepositoryRuleRequiredDeploymentsDict
Bases: TypedDict
Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
RepositoryRuleTagNamePatternDict
Bases: TypedDict
Parameters to be used for the tag_name_pattern rule.
RepositoryRuleUpdateDict
Bases: TypedDict
Only allow users with bypass permission to update matching refs.
RepositoryRulesetConditionsDict
Bases: TypedDict
Parameters for a repository ruleset ref name condition.
RepositoryRulesetEditedPayloadChangesConditionsUpdatedChangesDict
Bases: TypedDict
RepositoryRulesetEditedPayloadChangesConditionsUpdatedChanges.
RepositoryRulesetEditedPayloadChangesRulesUpdatedChangesDict
Bases: TypedDict
RepositoryRulesetEditedPayloadChangesRulesUpdatedChanges.
RepositoryRulesetLinksDict
Bases: TypedDict
RepositoryRulesetLinks.
RepositoryTransferredPayloadChangesOwnerFromDict
Bases: TypedDict
RepositoryTransferredPayloadChangesOwnerFrom.
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryVulnerabilityDict
Bases: TypedDict
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryVulnerability.
SponsorshipEditedPayloadChangesDict
Bases: TypedDict
SponsorshipEditedPayloadChanges.
StatusPayloadBrancheDict
Bases: TypedDict
StatusPayloadBranche.
StatusPayloadCommitCommitDict
Bases: TypedDict
StatusPayloadCommitCommit.
TeamAddedToRepositoryPayloadRepositoryDict
Bases: TypedDict
A git repository.
TeamCreatedPayloadRepositoryDict
Bases: TypedDict
A git repository.
TeamDeletedPayloadRepositoryDict
Bases: TypedDict
A git repository.
TeamEditedPayloadRepositoryDict
Bases: TypedDict
A git repository.
TeamRemovedFromRepositoryPayloadRepositoryDict
Bases: TypedDict
A git repository.
WebhookRubygemsMetadataDict
Bases: TypedDict
Ruby Gems metadata.
WebhooksAnswerDict
Bases: TypedDict
WebhooksAnswer.
WebhooksChangesDict
Bases: TypedDict
The changes to the comment.
WebhooksCommentDict
Bases: TypedDict
WebhooksComment.
WebhooksIssueCommentDict
WebhooksMarketplacePurchaseDict
Bases: TypedDict
Marketplace Purchase.
WebhooksPreviousMarketplacePurchaseDict
Bases: TypedDict
Marketplace Purchase.
WebhooksProjectChangesDict
Bases: TypedDict
WebhooksProjectChanges.
WebhooksPullRequest5BaseRepoDict
Bases: TypedDict
A git repository.
WebhooksPullRequest5HeadRepoDict
Bases: TypedDict
A git repository.
WebhooksPullRequest5LinksDict
Bases: TypedDict
WebhooksPullRequest5Links.
WebhooksRelease1Dict
WebhooksReleaseDict
WebhooksReviewCommentLinksDict
Bases: TypedDict
WebhooksReviewCommentLinks.
WebhooksReviewLinksDict
Bases: TypedDict
WebhooksReviewLinks.
WebhooksSecurityAdvisoryVulnerabilityDict
Bases: TypedDict
WebhooksSecurityAdvisoryVulnerability.
WebhooksSponsorshipDict
Bases: TypedDict
WebhooksSponsorship.
WorkflowJobQueuedPayloadWorkflowJobDict
Bases: TypedDict
WorkflowJobQueuedPayloadWorkflowJob.
WorkflowJobWaitingPayloadWorkflowJobDict
Bases: TypedDict
WorkflowJobWaitingPayloadWorkflowJob.
WorkflowRunCompletedPayloadWorkflowRunHeadCommitDict
Bases: TypedDict
SimpleCommit.
WorkflowRunInProgressPayloadWorkflowRunHeadCommitDict
Bases: TypedDict
SimpleCommit.
WorkflowRunRequestedPayloadWorkflowRunHeadCommitDict
Bases: TypedDict
SimpleCommit.
WorkflowRunRequestedPayloadWorkflowRunPullRequestBaseDict
Bases: TypedDict
WorkflowRunRequestedPayloadWorkflowRunPullRequestBase.
WorkflowRunRequestedPayloadWorkflowRunPullRequestHeadDict
Bases: TypedDict
WorkflowRunRequestedPayloadWorkflowRunPullRequestHead.
DependabotAlertDependencyDict
Bases: TypedDict
Details for the vulnerable dependency.
DependabotAlertSecurityVulnerabilityDict
Bases: TypedDict
Details pertaining to one vulnerable version range for the advisory.
PingPayloadHookDict
Bases: TypedDict
The webhook that is being pinged.
DiscussionDict
Bases: TypedDict
A Discussion in a repository.
PullRequestLinksDict
Bases: TypedDict
PullRequestLinks.
RepositoryRuleCodeScanningParametersDict
Bases: TypedDict
RepositoryRuleCodeScanningParameters.
RepositoryRuleParamsRequiredReviewerConfigurationDict
Bases: TypedDict
A reviewing team, and file patterns describing which files they must approve changes to.
RepositoryRuleRequiredStatusChecksParametersDict
Bases: TypedDict
RepositoryRuleRequiredStatusChecksParameters.
RepositoryRuleWorkflowsParametersDict
Bases: TypedDict
RepositoryRuleWorkflowsParameters.
SecretScanningLocationDict
Bases: TypedDict
SecretScanningLocation.
MergeGroupDict
Bases: TypedDict
A group of pull requests that the merge queue has grouped together to be merged.
CodeScanningAlertAppearedInBranchPayloadAlertDict
Bases: TypedDict
The code scanning alert involved in the event.
CodeScanningAlertClosedByUserPayloadAlertDict
Bases: TypedDict
The code scanning alert involved in the event.
CodeScanningAlertCreatedPayloadAlertDict
Bases: TypedDict
The code scanning alert involved in the event.
CodeScanningAlertFixedPayloadAlertDict
Bases: TypedDict
The code scanning alert involved in the event.
CodeScanningAlertReopenedByUserPayloadAlertDict
Bases: TypedDict
The code scanning alert involved in the event.
CodeScanningAlertReopenedPayloadAlertDict
Bases: TypedDict
The code scanning alert involved in the event.
DeploymentDict
Bases: TypedDict
A request for a specific ref(branch,sha,tag) to be deployed.
InstallationDict2
Bases: TypedDict
Installation.
MilestoneDict
Bases: TypedDict
A collection of related issues and pull requests.
MinimalRepositoryDict
Bases: TypedDict
Minimal Repository.
PersonalAccessTokenRequestDict
Bases: TypedDict
Details of a Personal Access Token Request.
ProjectsV2ItemDict
Bases: TypedDict
An item belonging to a project.
ProjectsV2StatusUpdateDict
Bases: TypedDict
An status update belonging to a project.
RepositoryDict2
Bases: TypedDict
A repository on GitHub.
RepositoryDict
Bases: TypedDict
The repository on GitHub where the event occurred. Webhook payloads contain the repository property when the event occurs from activity in a repository.
SecretScanningAlertWebhookDict
Bases: TypedDict
SecretScanningAlertWebhook.
CustomPropertyCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub custom_property webhook with action created.
CustomPropertyDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub custom_property webhook with action deleted.
CustomPropertyPromoteToEnterprisePayloadDict
Bases: TypedDict
Payload for the GitHub custom_property webhook with action promote_to_enterprise.
CustomPropertyUpdatedPayloadDict
Bases: TypedDict
Payload for the GitHub custom_property webhook with action updated.
GithubAppAuthorizationRevokedPayloadDict
Bases: TypedDict
Payload for the GitHub github_app_authorization webhook with action revoked.
IssuesDeletedPayloadIssueDict
IssuesDemilestonedPayloadIssueDict
IssuesEditedPayloadIssueDict
IssuesLabeledPayloadIssueDict
IssuesLockedPayloadIssueDict
IssuesMilestonedPayloadIssueDict
IssuesOpenedPayloadIssueDict
IssuesReopenedPayloadIssueDict
IssuesTransferredPayloadChangesNewIssueDict
IssuesUnlockedPayloadIssueDict
WebhooksIssueDict
WebhooksIssue2Dict
CheckSuiteCompletedPayloadCheckSuitePullRequestDict
Bases: TypedDict
Check Run Pull Request.
CheckSuiteRequestedPayloadCheckSuitePullRequestDict
Bases: TypedDict
Check Run Pull Request.
CheckSuiteRerequestedPayloadCheckSuitePullRequestDict
Bases: TypedDict
Check Run Pull Request.
DiscussionCategoryChangedPayloadChangesDict
Bases: TypedDict
DiscussionCategoryChangedPayloadChanges.
IssuesOpenedPayloadChangesDict
Bases: TypedDict
IssuesOpenedPayloadChanges.
PullRequestAssignedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestAssignedPayloadPullRequestBase.
PullRequestAutoMergeDisabledPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestAutoMergeDisabledPayloadPullRequestBase.
PullRequestAutoMergeDisabledPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestAutoMergeDisabledPayloadPullRequestHead.
PullRequestAutoMergeEnabledPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestAutoMergeEnabledPayloadPullRequestBase.
PullRequestAutoMergeEnabledPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestAutoMergeEnabledPayloadPullRequestHead.
PullRequestDequeuedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestDequeuedPayloadPullRequestBase.
PullRequestDequeuedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestDequeuedPayloadPullRequestHead.
PullRequestEditedPayloadChangesDict
Bases: TypedDict
The changes to the comment if the action was edited.
PullRequestEnqueuedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestEnqueuedPayloadPullRequestBase.
PullRequestEnqueuedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestEnqueuedPayloadPullRequestHead.
PullRequestLabeledPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestLabeledPayloadPullRequestBase.
PullRequestLockedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestLockedPayloadPullRequestBase.
PullRequestMinimalDict
Bases: TypedDict
Pull Request Minimal.
PullRequestReviewCommentCreatedPayloadCommentDict
PullRequestReviewCommentCreatedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestReviewCommentCreatedPayloadPullRequestBase.
PullRequestReviewCommentDeletedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestReviewCommentDeletedPayloadPullRequestBase.
PullRequestReviewCommentEditedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestReviewCommentEditedPayloadPullRequestBase.
PullRequestReviewDismissedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestReviewDismissedPayloadPullRequestBase.
PullRequestReviewDismissedPayloadReviewDict
Bases: TypedDict
The review that was affected.
PullRequestReviewEditedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestReviewEditedPayloadPullRequestBase.
PullRequestReviewSubmittedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestReviewSubmittedPayloadPullRequestBase.
PullRequestReviewThreadResolvedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestReviewThreadResolvedPayloadPullRequestBase.
PullRequestReviewThreadResolvedPayloadThreadCommentDict
PullRequestReviewThreadUnresolvedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestReviewThreadUnresolvedPayloadPullRequestBase.
PullRequestReviewThreadUnresolvedPayloadPullRequestHeadDict
Bases: TypedDict
PullRequestReviewThreadUnresolvedPayloadPullRequestHead.
PullRequestReviewThreadUnresolvedPayloadThreadCommentDict
PullRequestSynchronizePayloadPullRequestBaseDict
Bases: TypedDict
PullRequestSynchronizePayloadPullRequestBase.
PullRequestSynchronizePayloadPullRequestHeadDict
Bases: TypedDict
PullRequestSynchronizePayloadPullRequestHead.
PullRequestUnassignedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestUnassignedPayloadPullRequestBase.
PullRequestUnlabeledPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestUnlabeledPayloadPullRequestBase.
PullRequestUnlockedPayloadPullRequestBaseDict
Bases: TypedDict
PullRequestUnlockedPayloadPullRequestBase.
PushPayloadDict
Bases: TypedDict
Payload for the GitHub push webhook.
RepositoryRenamedPayloadChangesDict
Bases: TypedDict
RepositoryRenamedPayloadChanges.
RepositoryRulesetEditedPayloadChangesConditionsUpdatedDict
Bases: TypedDict
RepositoryRulesetEditedPayloadChangesConditionsUpdated.
SecurityAdvisoryWithdrawnPayloadSecurityAdvisoryDict
Bases: TypedDict
The details of the security advisory, including summary, description, and severity.
StatusPayloadCommitDict
Bases: TypedDict
StatusPayloadCommit.
TeamAddedToRepositoryPayloadDict
Bases: TypedDict
Payload for the GitHub team webhook with action added_to_repository.
TeamCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub team webhook with action created.
TeamDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub team webhook with action deleted.
TeamEditedPayloadChangesRepositoryDict
Bases: TypedDict
TeamEditedPayloadChangesRepository.
TeamRemovedFromRepositoryPayloadDict
Bases: TypedDict
Payload for the GitHub team webhook with action removed_from_repository.
PackageUpdatedPayloadPackagePackageVersionDict
Bases: TypedDict
PackageUpdatedPayloadPackagePackageVersion.
RegistryPackageUpdatedPayloadRegistryPackagePackageVersionDict
Bases: TypedDict
RegistryPackageUpdatedPayloadRegistryPackagePackageVersion.
WebhooksChanges8Dict
Bases: TypedDict
WebhooksChanges8.
WebhooksPullRequest5BaseDict
Bases: TypedDict
WebhooksPullRequest5Base.
WebhooksPullRequest5HeadDict
Bases: TypedDict
WebhooksPullRequest5Head.
WebhooksReviewCommentDict
WebhooksReviewDict
Bases: TypedDict
The review that was affected.
WebhooksSecurityAdvisoryDict
Bases: TypedDict
The details of the security advisory, including summary, description, and severity.
WorkflowRunCompletedPayloadWorkflowRunDict
Bases: TypedDict
Workflow Run.
WorkflowRunInProgressPayloadWorkflowRunDict
Bases: TypedDict
Workflow Run.
WorkflowRunRequestedPayloadWorkflowRunPullRequestDict
Bases: TypedDict
WorkflowRunRequestedPayloadWorkflowRunPullRequest.
DependabotAlertSecurityAdvisoryDict
Bases: TypedDict
Details for the GitHub Security Advisory.
ProjectsV2ItemEditedPayloadChangesOption1Dict
Bases: TypedDict
ProjectsV2ItemEditedPayloadChangesOption1.
RepositoryRuleCodeScanningDict
Bases: TypedDict
Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
RepositoryRulePullRequestParametersDict
Bases: TypedDict
RepositoryRulePullRequestParameters.
RepositoryRuleRequiredStatusChecksDict
Bases: TypedDict
Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
RepositoryRuleWorkflowsDict
Bases: TypedDict
Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
PersonalAccessTokenRequestApprovedPayloadDict
Bases: TypedDict
Payload for the GitHub personal_access_token_request webhook with action approved.
PersonalAccessTokenRequestCancelledPayloadDict
Bases: TypedDict
Payload for the GitHub personal_access_token_request webhook with action cancelled.
PersonalAccessTokenRequestCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub personal_access_token_request webhook with action created.
PersonalAccessTokenRequestDeniedPayloadDict
Bases: TypedDict
Payload for the GitHub personal_access_token_request webhook with action denied.
ProjectsV2ItemArchivedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2_item webhook with action archived.
ProjectsV2ItemConvertedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2_item webhook with action converted.
ProjectsV2ItemCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2_item webhook with action created.
ProjectsV2ItemDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2_item webhook with action deleted.
ProjectsV2ItemReorderedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2_item webhook with action reordered.
ProjectsV2ItemRestoredPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2_item webhook with action restored.
ProjectsV2Dict
Bases: TypedDict
A projects v2 project.
ProjectsV2StatusUpdateCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2_status_update webhook with action created.
ProjectsV2StatusUpdateDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2_status_update webhook with action deleted.
ProjectsV2StatusUpdateEditedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2_status_update webhook with action edited.
PullRequestBaseDict
Bases: TypedDict
PullRequestBase.
PullRequestHeadDict
Bases: TypedDict
PullRequestHead.
FullRepositoryDict
Bases: TypedDict
Full Repository.
IssueDict
Bases: TypedDict
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
DiscussionTransferredPayloadChangesDict
Bases: TypedDict
DiscussionTransferredPayloadChanges.
BranchProtectionConfigurationDisabledPayloadDict
Bases: TypedDict
Payload for the GitHub branch_protection_configuration webhook with action disabled.
BranchProtectionConfigurationEnabledPayloadDict
Bases: TypedDict
Payload for the GitHub branch_protection_configuration webhook with action enabled.
BranchProtectionRuleCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub branch_protection_rule webhook with action created.
BranchProtectionRuleDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub branch_protection_rule webhook with action deleted.
BranchProtectionRuleEditedPayloadDict
Bases: TypedDict
Payload for the GitHub branch_protection_rule webhook with action edited.
CodeScanningAlertAppearedInBranchPayloadDict
Bases: TypedDict
Payload for the GitHub code_scanning_alert webhook with action appeared_in_branch.
CodeScanningAlertClosedByUserPayloadDict
Bases: TypedDict
Payload for the GitHub code_scanning_alert webhook with action closed_by_user.
CodeScanningAlertCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub code_scanning_alert webhook with action created.
CodeScanningAlertFixedPayloadDict
Bases: TypedDict
Payload for the GitHub code_scanning_alert webhook with action fixed.
CodeScanningAlertReopenedPayloadDict
Bases: TypedDict
Payload for the GitHub code_scanning_alert webhook with action reopened.
CodeScanningAlertReopenedByUserPayloadDict
Bases: TypedDict
Payload for the GitHub code_scanning_alert webhook with action reopened_by_user.
CommitCommentCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub commit_comment webhook with action created.
CreatePayloadDict
Bases: TypedDict
Payload for the GitHub create webhook.
CustomPropertyValuesUpdatedPayloadDict
Bases: TypedDict
Payload for the GitHub custom-property-values webhook with action updated.
DeletePayloadDict
Bases: TypedDict
Payload for the GitHub delete webhook.
DeployKeyCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub deploy_key webhook with action created.
DeployKeyDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub deploy_key webhook with action deleted.
DeploymentCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub deployment webhook with action created.
DeploymentReviewApprovedPayloadDict
Bases: TypedDict
Payload for the GitHub deployment_review webhook with action approved.
DeploymentReviewRejectedPayloadDict
Bases: TypedDict
Payload for the GitHub deployment_review webhook with action rejected.
DeploymentReviewRequestedPayloadDict
Bases: TypedDict
Payload for the GitHub deployment_review webhook with action requested.
DeploymentStatusCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub deployment_status webhook with action created.
DiscussionAnsweredPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action answered.
DiscussionClosedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action closed.
DiscussionCommentCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion_comment webhook with action created.
DiscussionCommentDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion_comment webhook with action deleted.
DiscussionCommentEditedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion_comment webhook with action edited.
DiscussionCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action created.
DiscussionDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action deleted.
DiscussionEditedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action edited.
DiscussionLabeledPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action labeled.
DiscussionLockedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action locked.
DiscussionPinnedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action pinned.
DiscussionReopenedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action reopened.
DiscussionUnansweredPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action unanswered.
DiscussionUnlabeledPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action unlabeled.
DiscussionUnlockedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action unlocked.
DiscussionUnpinnedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action unpinned.
ForkPayloadDict
Bases: TypedDict
Payload for the GitHub fork webhook.
GollumPayloadDict
Bases: TypedDict
Payload for the GitHub gollum webhook.
InstallationCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub installation webhook with action created.
InstallationDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub installation webhook with action deleted.
InstallationNewPermissionsAcceptedPayloadDict
Bases: TypedDict
Payload for the GitHub installation webhook with action new_permissions_accepted.
InstallationRepositoriesAddedPayloadDict
Bases: TypedDict
Payload for the GitHub installation_repositories webhook with action added.
InstallationRepositoriesRemovedPayloadDict
Bases: TypedDict
Payload for the GitHub installation_repositories webhook with action removed.
InstallationSuspendPayloadDict
Bases: TypedDict
Payload for the GitHub installation webhook with action suspend.
InstallationTargetRenamedPayloadDict
Bases: TypedDict
Payload for the GitHub installation_target webhook with action renamed.
InstallationUnsuspendPayloadDict
Bases: TypedDict
Payload for the GitHub installation webhook with action unsuspend.
IssueCommentCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub issue_comment webhook with action created.
IssueCommentDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub issue_comment webhook with action deleted.
IssueCommentEditedPayloadDict
Bases: TypedDict
Payload for the GitHub issue_comment webhook with action edited.
IssuesClosedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action closed.
LabelCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub label webhook with action created.
LabelDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub label webhook with action deleted.
LabelEditedPayloadDict
Bases: TypedDict
Payload for the GitHub label webhook with action edited.
MarketplacePurchaseCancelledPayloadDict
Bases: TypedDict
Payload for the GitHub marketplace_purchase webhook with action cancelled.
MarketplacePurchaseChangedPayloadDict
Bases: TypedDict
Payload for the GitHub marketplace_purchase webhook with action changed.
MarketplacePurchasePendingChangePayloadDict
Bases: TypedDict
Payload for the GitHub marketplace_purchase webhook with action pending_change.
MarketplacePurchasePendingChangeCancelledPayloadDict
Bases: TypedDict
Payload for the GitHub marketplace_purchase webhook with action pending_change_cancelled.
MarketplacePurchasePurchasedPayloadDict
Bases: TypedDict
Payload for the GitHub marketplace_purchase webhook with action purchased.
MemberAddedPayloadDict
Bases: TypedDict
Payload for the GitHub member webhook with action added.
MemberEditedPayloadDict
Bases: TypedDict
Payload for the GitHub member webhook with action edited.
MemberRemovedPayloadDict
Bases: TypedDict
Payload for the GitHub member webhook with action removed.
MembershipAddedPayloadDict
Bases: TypedDict
Payload for the GitHub membership webhook with action added.
MembershipRemovedPayloadDict
Bases: TypedDict
Payload for the GitHub membership webhook with action removed.
MergeGroupChecksRequestedPayloadDict
Bases: TypedDict
Payload for the GitHub merge_group webhook with action checks_requested.
MergeGroupDestroyedPayloadDict
Bases: TypedDict
Payload for the GitHub merge_group webhook with action destroyed.
MetaDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub meta webhook with action deleted.
MilestoneClosedPayloadDict
Bases: TypedDict
Payload for the GitHub milestone webhook with action closed.
MilestoneCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub milestone webhook with action created.
MilestoneDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub milestone webhook with action deleted.
MilestoneEditedPayloadDict
Bases: TypedDict
Payload for the GitHub milestone webhook with action edited.
MilestoneOpenedPayloadDict
Bases: TypedDict
Payload for the GitHub milestone webhook with action opened.
OrgBlockBlockedPayloadDict
Bases: TypedDict
Payload for the GitHub org_block webhook with action blocked.
OrgBlockUnblockedPayloadDict
Bases: TypedDict
Payload for the GitHub org_block webhook with action unblocked.
OrganizationDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub organization webhook with action deleted.
OrganizationMemberAddedPayloadDict
Bases: TypedDict
Payload for the GitHub organization webhook with action member_added.
OrganizationMemberInvitedPayloadDict
Bases: TypedDict
Payload for the GitHub organization webhook with action member_invited.
OrganizationMemberRemovedPayloadDict
Bases: TypedDict
Payload for the GitHub organization webhook with action member_removed.
OrganizationRenamedPayloadDict
Bases: TypedDict
Payload for the GitHub organization webhook with action renamed.
PackagePublishedPayloadDict
Bases: TypedDict
Payload for the GitHub package webhook with action published.
PageBuildPayloadDict
Bases: TypedDict
Payload for the GitHub page_build webhook.
PingPayloadDict
Bases: TypedDict
Payload for the GitHub ping webhook.
ProjectCardConvertedPayloadDict
Bases: TypedDict
Payload for the GitHub project_card webhook with action converted.
ProjectCardCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub project_card webhook with action created.
ProjectCardDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub project_card webhook with action deleted.
ProjectCardEditedPayloadDict
Bases: TypedDict
Payload for the GitHub project_card webhook with action edited.
ProjectCardMovedPayloadDict
Bases: TypedDict
Payload for the GitHub project_card webhook with action moved.
ProjectClosedPayloadDict
Bases: TypedDict
Payload for the GitHub project webhook with action closed.
ProjectColumnCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub project_column webhook with action created.
ProjectColumnDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub project_column webhook with action deleted.
ProjectColumnEditedPayloadDict
Bases: TypedDict
Payload for the GitHub project_column webhook with action edited.
ProjectColumnMovedPayloadDict
Bases: TypedDict
Payload for the GitHub project_column webhook with action moved.
ProjectCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub project webhook with action created.
ProjectDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub project webhook with action deleted.
ProjectEditedPayloadDict
Bases: TypedDict
Payload for the GitHub project webhook with action edited.
ProjectReopenedPayloadDict
Bases: TypedDict
Payload for the GitHub project webhook with action reopened.
PublicPayloadDict
Bases: TypedDict
Payload for the GitHub public webhook.
PullRequestClosedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action closed.
PullRequestConvertedToDraftPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action converted_to_draft.
PullRequestOpenedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action opened.
PullRequestReadyForReviewPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action ready_for_review.
PullRequestReopenedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action reopened.
RegistryPackagePublishedPayloadDict
Bases: TypedDict
Payload for the GitHub registry_package webhook with action published.
ReleaseCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub release webhook with action created.
ReleaseDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub release webhook with action deleted.
ReleaseEditedPayloadDict
Bases: TypedDict
Payload for the GitHub release webhook with action edited.
ReleasePrereleasedPayloadDict
Bases: TypedDict
Payload for the GitHub release webhook with action prereleased.
ReleasePublishedPayloadDict
Bases: TypedDict
Payload for the GitHub release webhook with action published.
ReleaseReleasedPayloadDict
Bases: TypedDict
Payload for the GitHub release webhook with action released.
ReleaseUnpublishedPayloadDict
Bases: TypedDict
Payload for the GitHub release webhook with action unpublished.
RepositoryAdvisoryPublishedPayloadDict
Bases: TypedDict
Payload for the GitHub repository_advisory webhook with action published.
RepositoryAdvisoryReportedPayloadDict
Bases: TypedDict
Payload for the GitHub repository_advisory webhook with action reported.
RepositoryArchivedPayloadDict
Bases: TypedDict
Payload for the GitHub repository webhook with action archived.
RepositoryCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub repository webhook with action created.
RepositoryDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub repository webhook with action deleted.
RepositoryDispatchPayloadDict
Bases: TypedDict
Payload for the GitHub repository_dispatch webhook.
RepositoryEditedPayloadDict
Bases: TypedDict
Payload for the GitHub repository webhook with action edited.
RepositoryImportPayloadDict
Bases: TypedDict
Payload for the GitHub repository_import webhook.
RepositoryPrivatizedPayloadDict
Bases: TypedDict
Payload for the GitHub repository webhook with action privatized.
RepositoryPublicizedPayloadDict
Bases: TypedDict
Payload for the GitHub repository webhook with action publicized.
RepositoryUnarchivedPayloadDict
Bases: TypedDict
Payload for the GitHub repository webhook with action unarchived.
RepositoryVulnerabilityAlertCreatePayloadDict
Bases: TypedDict
Payload for the GitHub repository_vulnerability_alert webhook with action create.
RepositoryVulnerabilityAlertDismissPayloadDict
Bases: TypedDict
Payload for the GitHub repository_vulnerability_alert webhook with action dismiss.
RepositoryVulnerabilityAlertReopenPayloadDict
Bases: TypedDict
Payload for the GitHub repository_vulnerability_alert webhook with action reopen.
RepositoryVulnerabilityAlertResolvePayloadDict
Bases: TypedDict
Payload for the GitHub repository_vulnerability_alert webhook with action resolve.
SecretScanningScanCompletedPayloadDict
Bases: TypedDict
Payload for the GitHub secret_scanning_scan webhook with action completed.
SponsorshipCancelledPayloadDict
Bases: TypedDict
Payload for the GitHub sponsorship webhook with action cancelled.
SponsorshipCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub sponsorship webhook with action created.
SponsorshipEditedPayloadDict
Bases: TypedDict
Payload for the GitHub sponsorship webhook with action edited.
SponsorshipPendingCancellationPayloadDict
Bases: TypedDict
Payload for the GitHub sponsorship webhook with action pending_cancellation.
StarCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub star webhook with action created.
StarDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub star webhook with action deleted.
TeamAddPayloadDict
Bases: TypedDict
Payload for the GitHub team_add webhook.
WatchStartedPayloadDict
Bases: TypedDict
Payload for the GitHub watch webhook with action started.
WorkflowDispatchPayloadDict
Bases: TypedDict
Payload for the GitHub workflow_dispatch webhook.
WorkflowJobCompletedPayloadDict
Bases: TypedDict
Payload for the GitHub workflow_job webhook with action completed.
WorkflowJobInProgressPayloadDict
Bases: TypedDict
Payload for the GitHub workflow_job webhook with action in_progress.
WorkflowJobQueuedPayloadDict
Bases: TypedDict
Payload for the GitHub workflow_job webhook with action queued.
WorkflowJobWaitingPayloadDict
Bases: TypedDict
Payload for the GitHub workflow_job webhook with action waiting.
SecretScanningAlertAssignedPayloadDict
Bases: TypedDict
Payload for the GitHub secret_scanning_alert webhook with action assigned.
SecretScanningAlertCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub secret_scanning_alert webhook with action created.
SecretScanningAlertLocationCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub secret_scanning_alert_location webhook with action created.
SecretScanningAlertPubliclyLeakedPayloadDict
Bases: TypedDict
Payload for the GitHub secret_scanning_alert webhook with action publicly_leaked.
SecretScanningAlertReopenedPayloadDict
Bases: TypedDict
Payload for the GitHub secret_scanning_alert webhook with action reopened.
SecretScanningAlertResolvedPayloadDict
Bases: TypedDict
Payload for the GitHub secret_scanning_alert webhook with action resolved.
SecretScanningAlertUnassignedPayloadDict
Bases: TypedDict
Payload for the GitHub secret_scanning_alert webhook with action unassigned.
SecretScanningAlertValidatedPayloadDict
Bases: TypedDict
Payload for the GitHub secret_scanning_alert webhook with action validated.
IssuesDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action deleted.
IssuesDemilestonedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action demilestoned.
IssuesEditedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action edited.
IssuesLabeledPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action labeled.
IssuesLockedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action locked.
IssuesMilestonedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action milestoned.
IssuesReopenedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action reopened.
IssuesTransferredPayloadChangesDict
Bases: TypedDict
IssuesTransferredPayloadChanges.
IssuesUnlockedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action unlocked.
IssuesAssignedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action assigned.
IssuesTypedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action typed.
IssuesUnassignedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action unassigned.
IssuesUnlabeledPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action unlabeled.
IssuesUntypedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action untyped.
IssuesPinnedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action pinned.
IssuesUnpinnedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action unpinned.
CheckSuiteCompletedPayloadCheckSuiteDict
CheckSuiteRequestedPayloadCheckSuiteDict
CheckSuiteRerequestedPayloadCheckSuiteDict
DiscussionCategoryChangedPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action category_changed.
IssuesOpenedPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action opened.
PullRequestAssignedPayloadPullRequestDict
Bases: TypedDict
Pull Request.
PullRequestAutoMergeDisabledPayloadPullRequestDict
Bases: TypedDict
Pull Request.
PullRequestAutoMergeEnabledPayloadPullRequestDict
Bases: TypedDict
Pull Request.
PullRequestDequeuedPayloadPullRequestDict
Bases: TypedDict
Pull Request.
PullRequestEditedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action edited.
PullRequestEnqueuedPayloadPullRequestDict
Bases: TypedDict
Pull Request.
PullRequestLabeledPayloadPullRequestDict
Bases: TypedDict
Pull Request.
PullRequestLockedPayloadPullRequestDict
Bases: TypedDict
Pull Request.
SimpleCheckSuiteDict
Bases: TypedDict
A suite of checks performed on the code of a given code change.
PullRequestReviewCommentCreatedPayloadPullRequestDict
Bases: TypedDict
PullRequestReviewCommentCreatedPayloadPullRequest.
PullRequestReviewCommentDeletedPayloadPullRequestDict
Bases: TypedDict
PullRequestReviewCommentDeletedPayloadPullRequest.
PullRequestReviewCommentEditedPayloadPullRequestDict
Bases: TypedDict
PullRequestReviewCommentEditedPayloadPullRequest.
PullRequestReviewDismissedPayloadPullRequestDict
Bases: TypedDict
Simple Pull Request.
PullRequestReviewEditedPayloadPullRequestDict
Bases: TypedDict
Simple Pull Request.
PullRequestReviewSubmittedPayloadPullRequestDict
Bases: TypedDict
Simple Pull Request.
PullRequestReviewThreadResolvedPayloadPullRequestDict
Bases: TypedDict
Simple Pull Request.
PullRequestReviewThreadResolvedPayloadThreadDict
Bases: TypedDict
PullRequestReviewThreadResolvedPayloadThread.
PullRequestReviewThreadUnresolvedPayloadPullRequestDict
Bases: TypedDict
Simple Pull Request.
PullRequestReviewThreadUnresolvedPayloadThreadDict
Bases: TypedDict
PullRequestReviewThreadUnresolvedPayloadThread.
PullRequestSynchronizePayloadPullRequestDict
Bases: TypedDict
Pull Request.
PullRequestUnassignedPayloadPullRequestDict
Bases: TypedDict
Pull Request.
PullRequestUnlabeledPayloadPullRequestDict
Bases: TypedDict
Pull Request.
PullRequestUnlockedPayloadPullRequestDict
Bases: TypedDict
Pull Request.
RepositoryRenamedPayloadDict
Bases: TypedDict
Payload for the GitHub repository webhook with action renamed.
RepositoryRulesetEditedPayloadChangesConditionsDict
Bases: TypedDict
RepositoryRulesetEditedPayloadChangesConditions.
RepositoryTransferredPayloadChangesDict
Bases: TypedDict
RepositoryTransferredPayloadChanges.
SecurityAdvisoryWithdrawnPayloadDict
Bases: TypedDict
Payload for the GitHub security_advisory webhook with action withdrawn.
StatusPayloadDict
Bases: TypedDict
Payload for the GitHub status webhook.
TeamEditedPayloadChangesDict
Bases: TypedDict
The changes to the team if the action was edited.
PackageUpdatedPayloadPackageDict
Bases: TypedDict
Information about the package.
RegistryPackageUpdatedPayloadRegistryPackageDict
Bases: TypedDict
RegistryPackageUpdatedPayloadRegistryPackage.
SponsorshipPendingTierChangePayloadDict
Bases: TypedDict
Payload for the GitHub sponsorship webhook with action pending_tier_change.
SponsorshipTierChangedPayloadDict
Bases: TypedDict
Payload for the GitHub sponsorship webhook with action tier_changed.
WebhooksPullRequest5Dict
Bases: TypedDict
Pull Request.
SecurityAdvisoryPublishedPayloadDict
Bases: TypedDict
Payload for the GitHub security_advisory webhook with action published.
SecurityAdvisoryUpdatedPayloadDict
Bases: TypedDict
Payload for the GitHub security_advisory webhook with action updated.
WorkflowRunCompletedPayloadDict
Bases: TypedDict
Payload for the GitHub workflow_run webhook with action completed.
WorkflowRunInProgressPayloadDict
Bases: TypedDict
Payload for the GitHub workflow_run webhook with action in_progress.
WorkflowRunRequestedPayloadWorkflowRunDict
Bases: TypedDict
Workflow Run.
DependabotAlertDict
Bases: TypedDict
A Dependabot alert.
ProjectsV2ItemEditedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2_item webhook with action edited.
RepositoryRulePullRequestDict
Bases: TypedDict
Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
ProjectsV2ClosedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2 webhook with action closed.
ProjectsV2CreatedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2 webhook with action created.
ProjectsV2DeletedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2 webhook with action deleted.
ProjectsV2EditedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2 webhook with action edited.
ProjectsV2ReopenedPayloadDict
Bases: TypedDict
Payload for the GitHub projects_v2 webhook with action reopened.
PullRequestDict
Bases: TypedDict
Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.
SecurityAndAnalysisPayloadDict
Bases: TypedDict
Payload for the GitHub security_and_analysis webhook.
IssueDependenciesBlockedByAddedPayloadDict
Bases: TypedDict
Payload for the GitHub issue-dependencies webhook with action blocked_by_added.
IssueDependenciesBlockedByRemovedPayloadDict
Bases: TypedDict
Payload for the GitHub issue-dependencies webhook with action blocked_by_removed.
IssueDependenciesBlockingAddedPayloadDict
Bases: TypedDict
Payload for the GitHub issue-dependencies webhook with action blocking_added.
IssueDependenciesBlockingRemovedPayloadDict
Bases: TypedDict
Payload for the GitHub issue-dependencies webhook with action blocking_removed.
SubIssuesParentIssueAddedPayloadDict
Bases: TypedDict
Payload for the GitHub sub-issues webhook with action parent_issue_added.
SubIssuesParentIssueRemovedPayloadDict
Bases: TypedDict
Payload for the GitHub sub-issues webhook with action parent_issue_removed.
SubIssuesSubIssueAddedPayloadDict
Bases: TypedDict
Payload for the GitHub sub-issues webhook with action sub_issue_added.
SubIssuesSubIssueRemovedPayloadDict
Bases: TypedDict
Payload for the GitHub sub-issues webhook with action sub_issue_removed.
DiscussionTransferredPayloadDict
Bases: TypedDict
Payload for the GitHub discussion webhook with action transferred.
IssuesTransferredPayloadDict
Bases: TypedDict
Payload for the GitHub issues webhook with action transferred.
CheckSuiteCompletedPayloadDict
Bases: TypedDict
Payload for the GitHub check_suite webhook with action completed.
CheckSuiteRequestedPayloadDict
Bases: TypedDict
Payload for the GitHub check_suite webhook with action requested.
CheckSuiteRerequestedPayloadDict
Bases: TypedDict
Payload for the GitHub check_suite webhook with action rerequested.
PullRequestAssignedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action assigned.
PullRequestAutoMergeDisabledPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action auto_merge_disabled.
PullRequestAutoMergeEnabledPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action auto_merge_enabled.
PullRequestDequeuedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action dequeued.
PullRequestEnqueuedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action enqueued.
PullRequestLabeledPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action labeled.
PullRequestLockedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action locked.
CheckRunWithSimpleCheckSuiteDict
Bases: TypedDict
A check performed on the code of a given code change.
PullRequestReviewCommentCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request_review_comment webhook with action created.
PullRequestReviewCommentDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request_review_comment webhook with action deleted.
PullRequestReviewCommentEditedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request_review_comment webhook with action edited.
PullRequestReviewDismissedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request_review webhook with action dismissed.
PullRequestReviewEditedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request_review webhook with action edited.
PullRequestReviewSubmittedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request_review webhook with action submitted.
PullRequestReviewThreadResolvedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request_review_thread webhook with action resolved.
PullRequestReviewThreadUnresolvedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request_review_thread webhook with action unresolved.
PullRequestSynchronizePayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action synchronize.
PullRequestUnassignedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action unassigned.
PullRequestUnlabeledPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action unlabeled.
PullRequestUnlockedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action unlocked.
RepositoryTransferredPayloadDict
Bases: TypedDict
Payload for the GitHub repository webhook with action transferred.
TeamEditedPayloadDict
Bases: TypedDict
Payload for the GitHub team webhook with action edited.
PackageUpdatedPayloadDict
Bases: TypedDict
Payload for the GitHub package webhook with action updated.
RegistryPackageUpdatedPayloadDict
Bases: TypedDict
Payload for the GitHub registry_package webhook with action updated.
PullRequestDemilestonedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action demilestoned.
PullRequestMilestonedPayloadDict
Bases: TypedDict
Payload for the GitHub pull_request webhook with action milestoned.
WorkflowRunRequestedPayloadDict
Bases: TypedDict
Payload for the GitHub workflow_run webhook with action requested.
DependabotAlertAutoDismissedPayloadDict
Bases: TypedDict
Payload for the GitHub dependabot_alert webhook with action auto_dismissed.
DependabotAlertAutoReopenedPayloadDict
Bases: TypedDict
Payload for the GitHub dependabot_alert webhook with action auto_reopened.
DependabotAlertCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub dependabot_alert webhook with action created.
DependabotAlertDismissedPayloadDict
Bases: TypedDict
Payload for the GitHub dependabot_alert webhook with action dismissed.
DependabotAlertFixedPayloadDict
Bases: TypedDict
Payload for the GitHub dependabot_alert webhook with action fixed.
DependabotAlertReintroducedPayloadDict
Bases: TypedDict
Payload for the GitHub dependabot_alert webhook with action reintroduced.
DependabotAlertReopenedPayloadDict
Bases: TypedDict
Payload for the GitHub dependabot_alert webhook with action reopened.
RepositoryRulesetEditedPayloadChangesRulesUpdatedDict
Bases: TypedDict
RepositoryRulesetEditedPayloadChangesRulesUpdated.
RepositoryRulesetDict
Bases: TypedDict
A set of rules to apply when specified conditions are met.
DeploymentProtectionRuleRequestedPayloadDict
Bases: TypedDict
Payload for the GitHub deployment_protection_rule webhook with action requested.
CheckRunCompletedPayloadDict
Bases: TypedDict
Payload for the GitHub check_run webhook with action completed.
CheckRunCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub check_run webhook with action created.
CheckRunRequestedActionPayloadDict
Bases: TypedDict
Payload for the GitHub check_run webhook with action requested_action.
CheckRunRerequestedPayloadDict
Bases: TypedDict
Payload for the GitHub check_run webhook with action rerequested.
RepositoryRulesetEditedPayloadChangesRulesDict
Bases: TypedDict
RepositoryRulesetEditedPayloadChangesRules.
RepositoryRulesetCreatedPayloadDict
Bases: TypedDict
Payload for the GitHub repository_ruleset webhook with action created.
RepositoryRulesetDeletedPayloadDict
Bases: TypedDict
Payload for the GitHub repository_ruleset webhook with action deleted.
RepositoryRulesetEditedPayloadChangesDict
Bases: TypedDict
RepositoryRulesetEditedPayloadChanges.
RepositoryRulesetEditedPayloadDict
Bases: TypedDict
Payload for the GitHub repository_ruleset webhook with action edited.