Module github_webhook::payload_types
source · Structs
- 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.
- 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 ofoff
,non_admins
, oreveryone
. Actor and build lists are arrays of strings. - Activity related to a branch protection rule. For more information, see “About branch protection rules.”
- Activity related to a branch protection rule. For more information, see “About branch protection rules.”
- Activity related to a branch protection rule. For more information, see “About branch protection rules.”
- A deployment to a repository environment. This will only be populated if the check run was created by a GitHub Actions workflow job that references an environment.
- A commit comment is created. The type of activity is specified in the
action
property. - Metaproperties for Git author/committer information.
- A Git branch or tag is created.
- A Git branch or tag is deleted.
- A Dependabot alert.
- Details for the vulnerable package.
- The deployment.
- A user forks a repository.
- A wiki page is created or updated.
- The GitHub App installation.
- Installation
- Somebody renamed the user or organization account that a GitHub App is installed on.
- The issue itself.
- The comment itself.
- Activity related to an issue. The type of activity is specified in the action property.
- Activity related to repository collaborators. The type of activity is specified in the action property.
- The membership between the user and the organization. Not present when the action is
member_invited
. - A collection of related issues and pull requests.
- Page Build
- The project item itself. To find more information about the project item, you can use
node_id
(the node ID of the project item) andproject_node_id
(the node ID of the project) to query information in the GraphQL API. For more information, see “Using the API to manage projects.” - When a private repository is made public.
- The status of auto merging a pull request.
- The review that was affected.
- The comment itself.
- A workflow referenced/reused by the initial caller workflow
- The release object.
- Data related to a release.
- A git repository
- The security alert of the vulnerable dependency.
- Represents a ‘commit’ secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
- Represents an ‘issue_body’ secret scanning location type. This location type shows that a secret was detected in the body of an issue.
- Represents an ‘issue_comment’ secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
- Represents an ‘issue_title’ secret scanning location type. This location type shows that a secret was detected in the title of an issue.
- Details for the advisory pertaining to the Common Vulnerability Scoring System.
- A CWE weakness assigned to the advisory.
- The
tier_changed
andpending_tier_change
will include the original tier before the change or pending change. For more information, see the pending tier change payload. - Groups of organization members that gives permissions on specified repositories.
- The workflow job. Many
workflow_job
keys, such ashead_sha
,conclusion
, andstarted_at
are the same as those in acheck_run
object.
Enums
- How the author is associated with the repository.
- This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.