UNPKG

@octokit/openapi-webhooks-types

Version:

Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

640 lines (637 loc) 2.68 MB
/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ /** OneOf type helpers */ type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never }; type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U; type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? OneOf<[XOR<A, B>, ...Rest]> : never; export type paths = Record<string, never>; export interface webhooks { "branch-protection-configuration-disabled": { /** * This event occurs when there is a change to branch protection configurations for a repository. * For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." * For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. * @description All branch protections were disabled for a repository. */ post: operations["branch-protection-configuration/disabled"]; }; "branch-protection-configuration-enabled": { /** * This event occurs when there is a change to branch protection configurations for a repository. * For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." * For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. * @description All branch protections were enabled for a repository. */ post: operations["branch-protection-configuration/enabled"]; }; "branch-protection-rule-created": { /** * This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. * @description A branch protection rule was created. */ post: operations["branch-protection-rule/created"]; }; "branch-protection-rule-deleted": { /** * This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. * @description A branch protection rule was deleted. */ post: operations["branch-protection-rule/deleted"]; }; "branch-protection-rule-edited": { /** * This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. * @description A branch protection rule was edited. */ post: operations["branch-protection-rule/edited"]; }; "check-run-completed": { /** * This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/rest/checks/runs)" in the REST API documentation. * * For activity relating to check suites, use the `check-suite` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. * * Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. * * > [!NOTE] * > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description A check run was completed, and a conclusion is available. */ post: operations["check-run/completed"]; }; "check-run-created": { /** * This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/rest/checks/runs)" in the REST API documentation. * * For activity relating to check suites, use the `check-suite` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. * * Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. * * > [!NOTE] * > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description A new check run was created. */ post: operations["check-run/created"]; }; "check-run-requested-action": { /** * This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/rest/checks/runs)" in the REST API documentation. * * For activity relating to check suites, use the `check-suite` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. * * Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. * * > [!NOTE] * > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see "[Creating CI tests with the Checks API](https://docs.github.com/developers/apps/guides/creating-ci-tests-with-the-checks-api)." */ post: operations["check-run/requested-action"]; }; "check-run-rerequested": { /** * This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/rest/checks/runs)" in the REST API documentation. * * For activity relating to check suites, use the `check-suite` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. * * Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. * * > [!NOTE] * > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload. */ post: operations["check-run/rerequested"]; }; "check-suite-completed": { /** * This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/rest/checks/suites)" in the REST API documentation. * * For activity relating to check runs, use the `check_run` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. * * Repository and organization webhooks only receive payloads for the `completed` event types in repositories. * * > [!NOTE] * > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description All check runs in a check suite have completed, and a conclusion is available. */ post: operations["check-suite/completed"]; }; "check-suite-requested": { /** * This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/rest/checks/suites)" in the REST API documentation. * * For activity relating to check runs, use the `check_run` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. * * Repository and organization webhooks only receive payloads for the `completed` event types in repositories. * * > [!NOTE] * > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/graphql/reference/mutations#createcheckrun) or "[Create a check run](https://docs.github.com/rest/checks/runs#create-a-check-run)" in the REST API documentation. */ post: operations["check-suite/requested"]; }; "check-suite-rerequested": { /** * This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/rest/checks/suites)" in the REST API documentation. * * For activity relating to check runs, use the `check_run` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. * * Repository and organization webhooks only receive payloads for the `completed` event types in repositories. * * > [!NOTE] * > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) or "[Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite)" in the REST API documentation. */ post: operations["check-suite/rerequested"]; }; "code-scanning-alert-appeared-in-branch": { /** * This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. * @description A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert. */ post: operations["code-scanning-alert/appeared-in-branch"]; }; "code-scanning-alert-closed-by-user": { /** * This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. * @description Someone closed a code scanning alert. */ post: operations["code-scanning-alert/closed-by-user"]; }; "code-scanning-alert-created": { /** * This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. * @description A code scanning alert was created in a repository. */ post: operations["code-scanning-alert/created"]; }; "code-scanning-alert-fixed": { /** * This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. * @description A code scanning alert was fixed in a branch by a commit. */ post: operations["code-scanning-alert/fixed"]; }; "code-scanning-alert-reopened": { /** * This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. * @description A previously fixed code scanning alert reappeared in a branch. */ post: operations["code-scanning-alert/reopened"]; }; "code-scanning-alert-reopened-by-user": { /** * This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. * @description Someone reopened a code scanning alert. */ post: operations["code-scanning-alert/reopened-by-user"]; }; "commit-comment-created": { /** * This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/rest/commits/comments)" in the REST API documentation. * * For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * @description Someone commented on a commit. */ post: operations["commit-comment/created"]; }; create: { /** * This event occurs when a Git branch or tag is created. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * * **Notes**: * - This event will not occur when more than three tags are created at once. * - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. */ post: operations["create"]; }; "custom-property-created": { /** * This event occurs when there is activity relating to a custom property. * * For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. * @description A new custom property was created. */ post: operations["custom-property/created"]; }; "custom-property-deleted": { /** * This event occurs when there is activity relating to a custom property. * * For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. * @description A custom property was deleted. */ post: operations["custom-property/deleted"]; }; "custom-property-promoted-to-enterprise": { /** * This event occurs when there is activity relating to a custom property. * * For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. * @description A custom property was promoted to an enterprise. */ post: operations["custom-property/promote-to-enterprise"]; }; "custom-property-updated": { /** * This event occurs when there is activity relating to a custom property. * * For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. * @description A custom property was updated. */ post: operations["custom-property/updated"]; }; "custom-property-values-updated": { /** * This event occurs when there is activity relating to custom property values for a repository. * * For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/rest/repos/custom-properties)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. * @description The custom property values of a repository were updated. */ post: operations["custom-property-values/updated"]; }; delete: { /** * This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including * branch and tag deletions, use the [`push`](#push) webhook event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * * > [!NOTE] * > This event will not occur when more than three tags are deleted at once. */ post: operations["delete"]; }; "dependabot-alert-auto-dismissed": { /** * This event occurs when there is activity relating to Dependabot alerts. * * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A Dependabot alert was automatically closed by a Dependabot auto-triage rule. */ post: operations["dependabot-alert/auto-dismissed"]; }; "dependabot-alert-auto-reopened": { /** * This event occurs when there is activity relating to Dependabot alerts. * * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed. */ post: operations["dependabot-alert/auto-reopened"]; }; "dependabot-alert-created": { /** * This event occurs when there is activity relating to Dependabot alerts. * * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable. */ post: operations["dependabot-alert/created"]; }; "dependabot-alert-dismissed": { /** * This event occurs when there is activity relating to Dependabot alerts. * * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A Dependabot alert was manually closed. */ post: operations["dependabot-alert/dismissed"]; }; "dependabot-alert-fixed": { /** * This event occurs when there is activity relating to Dependabot alerts. * * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A manifest file change removed a vulnerability. */ post: operations["dependabot-alert/fixed"]; }; "dependabot-alert-reintroduced": { /** * This event occurs when there is activity relating to Dependabot alerts. * * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A manifest file change introduced a vulnerable dependency that had previously been fixed. */ post: operations["dependabot-alert/reintroduced"]; }; "dependabot-alert-reopened": { /** * This event occurs when there is activity relating to Dependabot alerts. * * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A Dependabot alert was manually reopened. */ post: operations["dependabot-alert/reopened"]; }; "deploy-key-created": { /** * This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. * @description A deploy key was created. */ post: operations["deploy-key/created"]; }; "deploy-key-deleted": { /** * This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. * @description A deploy key was deleted. */ post: operations["deploy-key/deleted"]; }; "deployment-created": { /** * This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. * * For activity relating to deployment status, use the `deployment_status` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. * @description A deployment was created. */ post: operations["deployment/created"]; }; "deployment-protection-rule-requested": { /** * This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/rest/deployments/environments). * * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. * @description A deployment protection rule was requested for an environment. */ post: operations["deployment-protection-rule/requested"]; }; "deployment-review-approved": { /** * This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. * * For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. * @description A deployment review was approved. */ post: operations["deployment-review/approved"]; }; "deployment-review-rejected": { /** * This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. * * For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. * @description A deployment review was rejected. */ post: operations["deployment-review/rejected"]; }; "deployment-review-requested": { /** * This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. * * For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. * @description A deployment review was requested. */ post: operations["deployment-review/requested"]; }; "deployment-status-created": { /** * This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. * * For activity relating to deployment creation, use the `deployment` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. * * > [!NOTE] * > A webhook event is not fired for deployment statuses with an `inactive` state. * @description A new deployment status was created. */ post: operations["deployment-status/created"]; }; "discussion-answered": { /** * This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). * * For activity relating to a comment on a discussion, use the `discussion_comment` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A comment on the discussion was marked as the answer. */ post: operations["discussion/answered"]; }; "discussion-category-changed": { /** * This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). * * For activity relating to a comment on a discussion, use the `discussion_comment` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description The category of a discussion was changed. */ post: operations["discussion/category-changed"]; }; "discussion-closed": { /** * This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). * * For activity relating to a comment on a discussion, use the `discussion_comment` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was closed. */ post: operations["discussion/closed"]; }; "discussion-comment-created": { /** * This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). * * For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A comment on a discussion was created. */ post: operations["discussion-comment/created"]; }; "discussion-comment-deleted": { /** * This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). * * For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A comment on a discussion was deleted. */ post: operations["discussion-comment/deleted"]; }; "discussion-comment-edited": { /** * This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). * * For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A comment on a discussion was edited. */ post: operations["discussion-comment/edited"]; }; "discussion-created": { /** * This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). * * For activity relating to a comment on a discussion, use the `discussion_comment` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was created. */ post: operations["discussion/created"]; }; "discussion-deleted": { /** * This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). * * For activity relating to a comment on a discussion, use the `discussion_comment` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was deleted. */ post: operations["discussion/deleted"]; }; "discussion-edited": { /** * This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). * * For activity relating to a comment on a discussion, use the `discussion_comment` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description The title or body on a discussion was edited, or the category of the discussion was changed. */ post: operations["discussion/edited"]; }; "discussion-labeled": { /** * This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). * * For activity relating to a comment on a discussion, use the `discussion_comment` event. * * To subs