Repository navigation
Releases
v2026.3.10.3
This release adds the issues / status_changed webhook event and an issue status field on issue payloads. Existing code that builds issue records by hand or switches exhaustively over issue events needs small changes.
⚠️ Breaking changes
- New
issuesevent in the sealed hierarchy:GitHubWebhookIssuesEventnow also permitsGitHubWebhookIssuesStatusChangedEvent. An exhaustiveswitchoverGitHubWebhookIssuesEventwithout adefaultno longer compiles. Add acase GitHubWebhookIssuesStatusChangedEvent ebranch. statuscomponent added to issue records:GitHubWebhookIssue(incommonand inissues),GitHubWebhookIssuesClosedIssue,GitHubWebhookIssuesOpenedIssue,GitHubWebhookIssuesTransferredChangesNewIssueand the other per-action issue records gained@Nullable GitHubWebhookIssueStatus statusin the middle of the component list. Code that calls their canonical constructors directly (mostly tests and fixtures) must pass the new argument,nullif there is no status. Records decoded from webhooks are not affected.
✨ What's new
- Issue status events: the decoder now handles
issuesevents with actionstatus_changedand returnsGitHubWebhookIssuesStatusChangedEvent. It carriesstatus(the new status) andchanges.changes.status().from()is the previous status ornull.changes.state()andchanges.stateReason()are set only when the change also closed or reopened the issue, or changed the close reason. Available in cloud and GHEC. GitHubWebhookIssueStatus: new record withcategory,idandname, available asissue.status()on every issue payload. It isnullwhen the issue has no status. Issue statuses are a GitHub preview feature, so only accounts enrolled in the preview receive them.
🔧 Improvements
- Updated to
common-core7. The webhook JSON mapper is now built on the sharedJsonMappers.snakeCase()base and behaves as before. Unknown enum constants still read asnull, and a JSON string is still read into a collection property as a collection of one.
Full Changelog: v2026.3.10.2...v2026.3.10.3
v2026.3.10.2
This release applies the latest webhook spec sync, types dates and ids, replaces the secret-scanning location details with one record, and moves the library onto common-core. Upgrading needs code changes if you read dates, ids or secret-scanning location details, or declare the old common-* modules.
⚠️ Breaking changes
- Dependencies:
common-utilandcommon-jsonare replaced bycommon-core. If yourmodule-info.javahasrequires common.utilorcommon.json, userequires common.core. The old artifacts no longer arrive transitively. - Dates are now typed: 168 payload fields changed from
StringtoInstant(167, for exampleGitHubWebhookCodeScanningAlertCreatedAlert.updatedAtandGitHubWebhookCodeScanningAlertReopenedAlert.dismissedAt) orOffsetDateTime(GitHubWebhookSimpleCommit.timestamp). Use the value directly, or calltoString()for the old text. - Ids are now
long: 11 components changed fromdoubletolong, for exampleGitHubWebhookProjectsV2Project.idandGitHubWebhookProjectsV2StatusUpdate.id. 16 changed fromDoubletoLong, for exampleGitHubWebhookIssueDependenciesBlockedByAddedEvent.blockedIssueIdandblockingIssueId. - Secret scanning location details:
GitHubWebhookSecretScanningAlertLocationCreatedLocationDetailswas a sealed interface with 13 per-location records (...DetailsBlobUrl,...DetailsPageUrl,...DetailsIssueTitleUrland so on). It is now one record with nullable components (blobUrl,pageUrl,issueTitleUrl,path,startLineand so on). Replace theswitchorinstanceofon the old records with null checks on the components. The 13 old record types are removed.
✨ What's new
- Actions log secret scans:
GitHubWebhookSecretScanningAlertLocationCreatedLocationTypehasACTIONS_LOG. - Custom property regex:
GitHubWebhookOrganizationCustomPropertyhas aregexcomponent, so its constructor changed.
Full Changelog: v2026.3.10.1...v2026.3.10.2
v2026.3.10.1
This release syncs the webhook models with the latest GitHub OpenAPI descriptions and adds the secret_scanning_public_monitoring_alert event family. Upgrading needs code changes if you reference the enum fallback constant UNKNOWN or one of the renamed types below.
⚠️ Breaking changes
- Enum fallback renamed: the fallback constant of 175 webhook enums changed from
UNKNOWN(wire value"unknown") toUNRECOGNIZED(wire value"unrecognized"), for exampleGitHubWebhookCreateRefTypeandGitHubWebhookProjectsV2ItemContentType. MigrateGitHubWebhookCreateRefType.UNKNOWN→GitHubWebhookCreateRefType.UNRECOGNIZEDinswitchbranches and comparisons.fromWirereturnsUNRECOGNIZEDfor a value the library does not know. - Exemption request metadata renamed:
GitHubWebhookSecretScanningPushProtectionExemptionRequestMetadata→GitHubWebhookExemptionRequestMetadataand its...MetadataReasonenum →GitHubWebhookExemptionRequestMetadataReason. This changes the type ofmetadatainGitHubWebhookExemptionRequest. - Secret scanning alert validity renamed:
GitHubWebhookSecretScanningAlertCreatedAlertValidity→GitHubWebhookPublicMonitoringAlertWebhookValidity. This changes the type ofvalidityinGitHubWebhookSecretScanningAlertCreatedAlert. - Label type replaced:
GitHubWebhookIssuesEditedLabelis removed andGitHubWebhookPullRequestLabeledLabeltakes its place, with the same components. It is the type oflabelorlabelsin the discussion, issue labeled, unlabeled and edited, label created, deleted, edited and unarchived, and pull request labeled and unlabeled events and their payloads (for exampleGitHubWebhookDiscussionLabeledEvent,GitHubWebhookLabelCreatedEvent,GitHubWebhookPullRequestLabeledPullRequest). - Issue labels retyped:
labelsinGitHubWebhookIssue,GitHubWebhookIssuesClosedIssue,GitHubWebhookIssuesEditedIssue,GitHubWebhookIssuesPinnedIssueandGitHubWebhookIssuesReopenedIssuechanged fromList<GitHubWebhookLabel>toList<GitHubWebhookPullRequestLabeledLabel>. Update code that reads these labels asGitHubWebhookLabel. - Rule parameter records gained components:
GitHubWebhookFilePathRestrictionParametersandGitHubWebhookMaxFileSizeParametersgained a nullableignoredFilePathslist, andGitHubWebhookPullRequestParametersgained a nullablerequireExtraApprovalForUnattributedChanges. They are trailing components, so constructor calls need one more argument (nullkeeps the old behavior); code that only reads webhooks is not affected. - Transferred issue has its own type: the
newIssuecomponent ofGitHubWebhookIssuesTransferredChangeschanged fromGitHubWebhookIssuesPinnedIssueto the newGitHubWebhookIssuesTransferredChangesNewIssue. Update variable and method signatures that use the old type. - New event type in the sealed
GitHubWebhookEvent:GitHubWebhookSecretScanningPublicMonitoringAlertEventis a new permitted subtype, so an exhaustiveswitchoverGitHubWebhookEventwithout adefaultbranch no longer compiles. Add a case for it (see What's new).
✨ What's new
- Secret scanning public monitoring alerts: the
secret_scanning_public_monitoring_alertwebhook is now parsed intoGitHubWebhookSecretScanningPublicMonitoringAlertEvent, with one record per action (created,dismissed,reopened,validated) andGitHubWebhookSecretScanningPublicMonitoringAlertUnknownActionEventfor any other action. The alert isGitHubWebhookPublicMonitoringAlertWebhook, including where the secret was found. GHEC only. The new package...webhook.secretscanningpublicmonitoringalertis exported and opened inmodule-info. - Dependabot reachability:
GitHubWebhookDependabotAlertFixedAlerthas a newreachabilitycomponent (GitHubWebhookDependabotAlertFixedAlertReachabilitywith averdictand an optionalreason). Because it is a new record component, its canonical constructor changed; this is a response record, so code that only reads webhooks is not affected.
Full Changelog: v2026.3.10.0...v2026.3.10.1
v2026.3.10.0
What's Changed
- feat: initial import of the typed GitHub webhook events, decoder and receiver by @piotr-janczukowicz in #1
New Contributors
- @piotr-janczukowicz made their first contribution in #1
Full Changelog: https://github.com/piotr-janczukowicz/github-webhook/commits/v2026.3.10.0