Gathering detailed insights and metrics for @octokit/webhooks-types
Gathering detailed insights and metrics for @octokit/webhooks-types
Gathering detailed insights and metrics for @octokit/webhooks-types
Gathering detailed insights and metrics for @octokit/webhooks-types
@octokit/openapi-webhooks-types
Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
@octokit/openapi-webhooks-types-ghec
Generated TypeScript definitions based on GitHub's OpenAPI spec for ghec
@octokit/openapi-webhooks-types-transition
Transition package for OpenAPI Webhooks Types
@octokit/openapi-webhooks-types-github.ae
Generated TypeScript definitions based on GitHub's OpenAPI spec for github.ae
machine-readable, always up-to-date GitHub Webhooks specifications
npm install @octokit/webhooks-types
Typescript
Module System
Node Version
NPM Version
99.9
Supply Chain
85.2
Quality
77.8
Maintenance
100
Vulnerability
100
License
TypeScript (97.6%)
JavaScript (2.4%)
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
MIT License
248 Stars
931 Commits
42 Forks
12 Watchers
7 Branches
36 Contributors
Updated on Jul 16, 2025
Latest Version
7.6.1
Package Id
@octokit/webhooks-types@7.6.1
Unpacked Size
217.67 kB
Size
29.92 kB
File Count
3
NPM Version
10.8.3
Node Version
20.17.0
Published on
Oct 03, 2024
Cumulative downloads
Total Downloads
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
machine-readable, always up-to-date GitHub Webhooks specifications
Download the latest specification at octokit.github.io/webhooks/payload-examples/api.github.com/index.json
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.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
packaging workflow detected
Details
Reason
SAST tool is run on all commits
Details
Reason
security policy file detected
Details
Reason
1 existing vulnerabilities detected
Details
Reason
3 commit(s) and 4 issue activity found in the last 90 days -- score normalized to 5
Reason
dependency not pinned by hash detected -- score normalized to 4
Details
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
Score
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