NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
npm · #3544 most downloaded on npm
GitHub webhook events toolset for Node.js
Last release 9 months ago
03 Dec 2025
Release timing varies
gaps range from 9 days to 4 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
1 version withdrawn
withdrawn after publishing
9 years old
286 releases · first in 2017
types: Update "sign" and "verify" types in generate-types.js
README: link to event-handler module docs
One column per quarter.
## 7.6.3 (2020-06-06) ### Bug Fixes * docs: fix links in README
intellisesne: intellisense for array arg in on
declaration-type: fix missing return type on createWebhooksApi
{ Webhooks } = require("@octokit/webhooks") export. Deprecates { createWebhooksApi } = require("@octokit/webhooks")
installation.{suspend,unsuspend} actions
new event actions and payload types
const EventHandler = require('@octokit/webhooks/event-handler') is deprecated, use const { createEventHandler } = require('@octokit/webhooks') instead
const EventHandler = require('@octokit/webhooks/event-handler') is deprecated, use const { createEventHandler } = require('@octokit/webhooks') insteadconst Middleware = require('@octokit/webhooks/middleware') is deprecated, use const { createMiddleware } = require('@octokit/webhooks') insteadconst sign = require('@octokit/webhooks/sign') is deprecated, use const { sign } = require('@octokit/webhooks') insteadconst verify = require('@octokit/webhooks/verify') is deprecated, use const { verify } = require('@octokit/webhooks') insteadTypeScript: "ping" event payload definitions
typescript: sponsorship.maintainer is now sponsorship.sponsorable
## 7.1.1 (2020-03-22) ### Bug Fixes * remove pify dependency
deployment.created, deployment_status.created, sponsorship
registry_package event was renamed to package
registry_package event was renamed to packagedo not uppercase quoted escape sequences
## 6.3.1 (2019-10-02) ### Bug Fixes * removeListener
# 6.3.0 (2019-09-16) ### Features * add repository_dispatch event
typescript: updates based on new responses from developer.github.com docs
typescript: add "draft" key to "pull_request" event payload
# 6.2.0 (2019-05-10) ### Features * package registry events
Tons of new Events and actions: https://developer.github.com/changes/2019-04-18-new-webhook-events-and-actions/
Tons of new Events and actions: https://developer.github.com/changes/2019-04-18-new-webhook-events-and-actions/
DeployKeyEvent
added - Triggered when a deploy key is added to a repository.removed - Triggered when a deploy key is removed from a repository.IssueEvent
locked - Triggered when an issue is locked.unlocked - Triggered when an issue is unlocked.MetaEvent
deleted - Triggered when the hook itself is deleted.OrganizationEvent
renamed - Triggered when the organization is renamed.deleted - Triggered when the organization is deleted.PullRequestEvent
locked - Triggered when an pull request is locked.unlocked - Triggered when an pull request is unlocked.ReleaseEvent
created - Triggered when a release is created.edited - Triggered when a release is edited.deleted - Triggered when a release is deleted.prereleased - Triggered when a release is prereleased.unpublished - Triggered when a release is unpublished.RepositoryEvent
edited - Triggered when attributes on a repostory (e.g. description, default branch, homepage) are changed.renamed - Triggered when a repository is renamed.transferred - Triggered when a repository is transferred to a new owner.StarEvent
created - Triggered when a star is added to a repository.deleted - Triggered when a star is removed from a repository.package: remove buffer-equal-constant-time
travis: drop support for Node 6
typescript: Mark next function argument in middleware as optional
new event content_reference, new actions installation.new_permissions_accepted, issues.pinned, issues.unpinned, and pull_request.ready_for_review
## 5.3.3 (2019-02-18) ### Bug Fixes * typescript: naming collision
typescript: Fix errors from linters and an update for signatures
typescript: export Webhooks explicitly
typescript: definitions for .verify, .verifyAndReceive, .receive, .removeListener, .middleware methods
# 5.2.0 (2019-01-26) ### Features * typescript definitions
remove obsolete and invalid events & actions
add known actions for project & project_card webhooks
# 5.1.0 (2018-12-10) ### Features * content_reference event
add known webhook names and actions
# 🚨This is a security update ### Bug Fixes * handle invalid JSON in payload
package: update debug to version 4.0.0
trigger error handler when missing headers
log warning instead of throwing error for unknown events
<a name="4.0.0"></a>
webhooks.on(woodstock, handler)
Now it logs a warning: "woodstock" is not a known webhook name (https://developer.github.com/v3/activity/events/types/)
## 3.1.1 (2018-03-14) ### Bug Fixes * move debug to dependencies
api.verifyAndReceive({id, name, payload, signature})
don’t pass signature to eventHandler.receive in middleware
## 3.0.1 (2017-11-27) ### Bug Fixes * timing attach vulnerability
event.data is now event.payload
<a name="3.0.0"></a>
event.data is now event.payload{id, name, payload} objectBefore
webhooks.on(push, (data, {id, name}) => {})
Now
webhooks.on(push, ({id, name, payload}) => {})
event-handler: add .sign() and .verify() methods
<a name="2.0.0"></a>
.sign() and .verify() methods (6c6e9ea)Before, this would throw an error
webhooks.receive({id, name, data, signature: invalid})
Now, the signature option is ignored as it’s assumed that the request has been already validated. This makes testing much easier, see https://github.com/probot/probot/pull/335#discussion_r152170945. If you use the EventHandler directly in a framework like hapi, make sure to verify the request before using the receive method using eventHandler.verify(data, signature)
# 1.0.0 (2017-11-21) ### Features * initial version
Your coding agent can read these notes before it upgrades. Set up the MCP server →