npmpackage.info

Gathering detailed insights and metrics for @octokit/webhooks-types

Other packages similar to @octokit/webhooks-types

@octokit/openapi-webhooks-types

12.0.3

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

@octokit/openapi-webhooks-types-ghec

12.0.3

Generated TypeScript definitions based on GitHub's OpenAPI spec for ghec

@octokit/openapi-webhooks-types-transition

12.0.3

Transition package for OpenAPI Webhooks Types

@octokit/openapi-webhooks-types-github.ae

9.0.0

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

Gathering detailed insights and metrics for @octokit/webhooks-types

@octokit/webhooks-types - 7.6.1 | npmpackage.info

@octokit/webhooks-types

machine-readable, always up-to-date GitHub Webhooks specifications

7.6.1

248

MIT

TypeScript

217.67 kB

6.7

Installations

npm install @octokit/webhooks-types

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Node Version

20.17.0

NPM Version

10.8.3 Pull Requests

Open

6

Total

884

Closed

42

Merged

836

Issues

Open

12

Total

109

Closed

97

Releases

271

v7.6.1

Updated on Oct 03, 2024

v7.6.0

Updated on Oct 03, 2024

v7.5.1

Updated on Apr 22, 2024

v7.5.0

Updated on Apr 03, 2024

v7.4.0

Updated on Mar 11, 2024

v7.3.2

Updated on Feb 03, 2024

View All 271 releases

Languages

TypeScript

JavaScript

TypeScript (97.6%)

JavaScript (2.4%)

Developer

octokit

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

248 Stars

931 Commits

42 Forks

12 Watchers

7 Branches

36 Contributors

Updated on Jul 16, 2025

Maintainers

View All 36 Contributors

Package Meta Information

Latest Version

7.6.1

Package Id

@octokit/webhooks-types@7.6.1

Unpacked Size

217.67 kB

Size

29.92 kB

File Count

NPM Version

10.8.3

Node Version

20.17.0

Published on

Oct 03, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Octokit Webhooks

machine-readable, always up-to-date GitHub Webhooks specifications

Download

Download the latest specification at octokit.github.io/webhooks/payload-examples/api.github.com/index.json

Usage

This package ships with types for the webhook events generated from the respective json schemas, which you can use like so:

1import { WebhookEvent, IssuesOpenedEvent } from "@octokit/webhooks-types";
2
3const handleWebhookEvent = (event: WebhookEvent) => {
4  if ("action" in event && event.action === "completed") {
5    console.log(`${event.sender.login} completed something!`);
6  }
7};
8
9const handleIssuesOpenedEvent = (event: IssuesOpenedEvent) => {
10  console.log(
11    `${event.sender.login} opened "${event.issue.title}" on ${event.repository.full_name}`,
12  );
13};

⚠️ Caution ⚠️: Webhooks Types are expected to be used with the strictNullChecks option enabled in your tsconfig. If you don't have this option enabled, there's the possibility that you get never as the inferred type in some use cases. See #395 for details.

LICENSE

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

10

SAST

Determines if the project uses static code analysis.

9

Security-Policy

Determines if the project has published a security policy.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Maintained

Determines if the project is "actively maintained".

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 4

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/add_to_octokit_project.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/add_to_octokit_project.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/codeql-analysis.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/immediate-response.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/immediate-response.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prettier.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/prettier.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-notification.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/release-notification.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-notification.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/release-notification.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-notification.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/release-notification.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-notification.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/release-notification.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/update-prettier.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/update-prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/update.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/update.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/update.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/update.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/webhooks/update.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:34
Info: 9 out of 21 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 10 third-party GitHubAction dependencies pinned
Info: 8 out of 9 npmCommand dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @octokit/webhooks-types

Other packages similar to @octokit/webhooks-types

@octokit/webhooks-types

Installations

Developer Guide

Yes

N/A

20.17.0

10.8.3

Pull Requests

6

884

42

836

Issues

12

109

97

Releases

Languages

Developer

octokit

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Octokit Webhooks

Download

Usage

See also

LICENSE

10

10

10

10

10

9

9

5

4

0

0

0

6.7

/10