GitHub webhook events toolset for Node.js
npm install @octokit/webhooks> GitHub webhook events toolset for Node.js
- Usage
- Local development
- API
- Constructor
- webhooks.sign()
- webhooks.verify()
- webhooks.verifyAndReceive()
- webhooks.receive()
- webhooks.on()
- webhooks.onAny()
- webhooks.onError()
- webhooks.removeListener()
- createNodeMiddleware()
- Webhook events
- emitterEventNames
- validateEventName
- TypeScript
- EmitterWebhookEventName
- EmitterWebhookEvent
- License
@octokit/webhooks helps to handle webhook events received from GitHub.
GitHub webhooks can be registered in multiple ways
1. In repository or organization settings on github.com.
2. Using the REST API for repositories or organizations
3. By creating a GitHub App.
Note that while setting a secret is optional on GitHub, it is required to be set in order to use @octokit/webhooks. Content Type must be set to application/json, application/x-www-form-urlencoded is not supported.
``js
// install with: npm install @octokit/webhooks
import { Webhooks, createNodeMiddleware } from "@octokit/webhooks";
import { createServer } from "node:http";
const webhooks = new Webhooks({
secret: "mysecret",
});
webhooks.onAny(({ id, name, payload }) => {
console.log(name, "event received");
});
createServer(createNodeMiddleware(webhooks)).listen(3000);
// can now receive webhook events at /api/github/webhooks
`
You can receive webhooks on your local machine or even browser using EventSource and smee.io.
Go to smee.io and Start a new channel. Then copy the "Webhook Proxy URL" and
1. enter it in the GitHub App’s "Webhook URL" input
2. pass it to the EventSource constructor, see below
`js`
const webhookProxyUrl = "https://smee.io/IrqK0nopGAOc847"; // replace with your own Webhook Proxy URL
const source = new EventSource(webhookProxyUrl);
source.onmessage = (event) => {
const webhookEvent = JSON.parse(event.data);
webhooks
.verifyAndReceive({
id: webhookEvent["x-request-id"],
name: webhookEvent["x-github-event"],
signature: webhookEvent["x-hub-signature"],
payload: JSON.stringify(webhookEvent.body),
})
.catch(console.error);
};
EventSource is a native browser API and can be polyfilled for browsers that don’t support it. In node, you can use the eventsource package: install with npm install eventsource, then import EventSource from "eventsource";)
1. Constructor
1. webhooks.sign()
1. webhooks.verify()
1. webhooks.verifyAndReceive()
1. webhooks.receive()
1. webhooks.on()
1. webhooks.onAny()
1. webhooks.onError()
1. webhooks.removeListener()
1. createNodeMiddleware()
1. createWebMiddleware()
1. Webhook events
1. emitterEventNames
1. validateEventName
`js`
new Webhooks({ secret /, transform / });
secret(String) | Required. Secret as configured in GitHub Settings. |
transform(Function) | Only relevant for webhooks.on.Transform emitted event before calling handlers. Can be asynchronous. |
logobject | Used for internal logging. Defaults to console |
Returns the webhooks API.
`js`
webhooks.sign(eventPayload);
eventPayload(String) | Required. Webhook request payload as received from GitHub |
Returns a signature string. Throws error if eventPayload is not passed.
The sign method can be imported as static method from @octokit/webhooks-methods.
`js`
webhooks.verify(eventPayload, signature);
eventPayload(String) | Required. Webhook event request payload as received from GitHub. |
signature(String) | Required. Signature string as calculated by webhooks.sign(). |
Returns true or false. Throws error if eventPayload or signature not passed.
The verify method can be imported as static method from @octokit/webhooks-methods.
`js`
webhooks.verifyAndReceive({ id, name, payload, signature });
idString | Unique webhook event request id |
nameString | Required. Name of the event. (Event names are set as X-GitHub-Event headerin the webhook event request.) |
payloadString | Required. Webhook event request payload as received from GitHub. |
signature(String) | Required. Signature string as calculated by webhooks.sign(). |
Returns a promise.
Verifies event using webhooks.verify(), then handles the event using webhooks.receive().
Additionally, if verification fails, rejects the returned promise and emits an error event.
Example
`js
import { Webhooks } from "@octokit/webhooks";
const webhooks = new Webhooks({
secret: "mysecret",
});
eventHandler.on("error", handleSignatureVerificationError);
// put this inside your webhooks route handler
eventHandler
.verifyAndReceive({
id: request.headers["x-github-delivery"],
name: request.headers["x-github-event"],
payload: request.body,
signature: request.headers["x-hub-signature-256"],
})
.catch(handleErrorsFromHooks);
`
`js`
webhooks.receive({ id, name, payload });
idString | Unique webhook event request id |
nameString | Required. Name of the event. (Event names are set as X-GitHub-Event headerin the webhook event request.) |
payloadObject | Required. Webhook event request payload as received from GitHub. |
Returns a promise. Runs all handlers set with webhooks.on() in parallel and waits for them to finish. If one of the handlers rejects or throws an error, then webhooks.receive() rejects. The returned error has an .errors property which holds an array of all errors caught from the handlers. If no errors occur, webhooks.receive() resolves without passing any value.
The .receive() method belongs to the event-handler module which can be used standalone.
`js`
webhooks.on(eventName, handler);
webhooks.on(eventNames, handler);
eventNameString | Required. Name of the event. One of GitHub's supported event names, or (if the event has an action property) the name of an event followed by its action in the form of <event>.<action>. |
eventNamesArray | Required. Array of event names. |
handlerFunction | Required. Method to be run each time the event with the passed name is received. the handler function can be an async function, throw an error orreturn a Promise. The handler is called with an event object: {id, name, payload}. |
The .on() method belongs to the event-handler module which can be used standalone.
`js`
webhooks.onAny(handler);
handlerFunction | Required. Method to be run each time any event is received. the handler function can be an async function, throw an error orreturn a Promise. The handler is called with an event object: {id, name, payload}. |
The .onAny() method belongs to the event-handler module which can be used standalone.
`js`
webhooks.onError(handler);
If a webhook event handler throws an error or returns a promise that rejects, an error event is triggered. You can use this handler for logging or reporting events. The passed error object has a .event property which has all information on the event.
Asynchronous error event handler are not blocking the .receive() method from completing.
handlerFunction | Required. Method to be run each time a webhook event handler throws an error or returns a promise that rejects. The handler function can be an async function,return a Promise. The handler is called with an error object that has a .event property which has all the information on the event: {id, name, payload}. |
The .onError() method belongs to the event-handler module which can be used standalone.
`js`
webhooks.removeListener(eventName, handler);
webhooks.removeListener(eventNames, handler);
eventNameString | Required. Name of the event. One of GitHub's supported event names, or (if the event has an action property) the name of an event followed by its action in the form of <event>.<action>, or '*' for the onAny() method or 'error' for the onError() method. |
eventNamesArray | Required. Array of event names. |
handlerFunction | Required. Method which was previously passed to webhooks.on(). If the same handler was registered multiple times for the same event, only the most recent handler gets removed. |
The .removeListener() method belongs to the event-handler module which can be used standalone.
`js
import { createServer } from "node:http";
import { Webhooks, createNodeMiddleware } from "@octokit/webhooks";
const webhooks = new Webhooks({
secret: "mysecret",
});
const middleware = createNodeMiddleware(webhooks, { path: "/webhooks" });
createServer(async (req, res) => {
// middleware returns false when req is unhandled (beyond /webhooks)`
if (await middleware(req, res)) return;
res.writeHead(404);
res.end();
}).listen(3000);
// can now receive user authorization callbacks at POST /webhooks
The middleware returned from createNodeMiddleware can also serve as anExpress.js middleware directly.
webhooksWebhooks instance | Required. |
pathstring | Custom path to match requests against. Defaults to /api/github/webhooks. |
logobject | Used for internal logging. Defaults to console |
`js
import { Webhooks, createWebMiddleware } from "@octokit/webhooks";
const webhooks = new Webhooks({
secret: "mysecret",
});
const middleware = createWebMiddleware(webhooks, { path: "/webhooks" });
// Example usage in Deno
Deno.serve({ port: 3000 }, middleware);
`
The middleware returned from createWebMiddleware can also be used in serverless environments like AWS Lambda, Cloudflare Workers, and Vercel.
webhooksWebhooks instance | Required. |
pathstring | Custom path to match requests against. Defaults to /api/github/webhooks. |
logobject | Used for internal logging. Defaults to console |
See the full list of event types with example payloads.
If there are actions for a webhook, events are emitted for both, the webhook name as well as a combination of the webhook name and the action, e.g. installation and installation.created.
| Event | Actions |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| branch_protection_configuration | disabled |branch_protection_rule
| | created |check_run
| | completed |check_suite
| | completed |code_scanning_alert
| | appeared_in_branch |commit_comment
| | created |create
| | |custom_property
| | created |custom_property_values
| | updated |delete
| | |dependabot_alert
| | auto_dismissed |deploy_key
| | created |deployment
| | created |deployment_protection_rule
| | requested |deployment_review
| | approved |deployment_status
| | created |discussion
| | answered |discussion_comment
| | created |fork
| | |github_app_authorization
| | revoked |gollum
| | |installation
| | created |installation_repositories
| | added |installation_target
| | renamed |issue_comment
| | created |issue_dependencies
| | blocked_by_added |issues
| | assigned |label
| | created |marketplace_purchase
| | cancelled |member
| | added |membership
| | added |merge_group
| | checks_requested |meta
| | deleted |milestone
| | closed |org_block
| | blocked |organization
| | deleted |package
| | published |page_build
| | |personal_access_token_request
| | approved |ping
| | |project
| | closed |project_card
| | converted |project_column
| | created |projects_v2
| | closed |projects_v2_item
| | archived |projects_v2_status_update
| | created |public
| | |pull_request
| | assigned |pull_request_review
| | dismissed |pull_request_review_comment
| | created |pull_request_review_thread
| | resolved |push
| | |registry_package
| | published |release
| | created |repository
| | archived |repository_advisory
| | published |repository_dispatch
| | sample |repository_import
| | |repository_ruleset
| | created |repository_vulnerability_alert
| | create |secret_scanning_alert
| | assigned |secret_scanning_alert_location
| | created |secret_scanning_scan
| | completed |security_advisory
| | published |security_and_analysis
| | |sponsorship
| | cancelled |star
| | created |status
| | |sub_issues
| | parent_issue_added |team
| | added_to_repository |team_add
| | |watch
| | started |workflow_dispatch
| | |workflow_job
| | completed |workflow_run
| | completed |
A read only tuple containing all the possible combinations of the webhook events + actions listed above. This might be useful in GUI and input validation.
`js`
import { emitterEventNames } from "@octokit/webhooks";
emitterEventNames; // ["check_run", "check_run.completed", ...]
The function validateEventName asserts that the provided event name is a valid event name or event/action combination.
It throws an error if the event name is not valid, or '\*' or 'error' is passed.
The second parameter is an optional options object that can be used to customize the behavior of the validation. You can set
a onUnknownEventName property to "warn" to log a warning instead of throwing an error, and a log property to provide a custom logger object, which should have a "warn" method. You can also set onUnknownEventName to "ignore" to disable logging or throwing an error for unknown event names.
`ts
import { validateEventName } from "@octokit/webhooks";
validateEventName("push"); // no error
validateEventName("invalid_event"); // throws an error
validateEventName("*"); // throws an error
validateEventName("error"); // throws an error
validateEventName("invalid_event", { onUnknownEventName: "warn" }); // logs a warning
validateEventName("invalid_event", {
onUnknownEventName: false,
log: {
warn: console.info, // instead of warning we just log it via console.info
},
});
validateEventName("*", { onUnkownEventName: "ignore" }); // throws an error
validateEventName("invalid_event", { onUnkownEventName: "ignore" }); // no error, no warning
`
The types for the webhook payloads are sourced from @octokit/openapi-webhooks-types,
which can be used by themselves.
In addition to these types, @octokit/webhooks exports 2 types specific to itself:
Note that changes to the exported types are not considered breaking changes, as the changes will not impact production code, but only fail locally or during CI at build time.
> [!IMPORTANT]
> As we use conditional exports, you will need to adapt your tsconfig.json by setting "moduleResolution": "node16", "module": "node16".
>
> See the TypeScript docs on package.json "exports".
> See this helpful guide on transitioning to ESM from @sindresorhus
⚠️ 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 octokit/webhooks#395 for details.
A union of all possible events and event/action combinations supported by the event emitter, e.g. "check_run" | "check_run.completed" | ... many more ... | "workflow_run.requested".
The object that is emitted by @octokit/webhooks as an event; made up of an id, name, and payload properties.name
An optional generic parameter can be passed to narrow the type of the and payload properties based on event names or event/action combinations, e.g. EmitterWebhookEvent<"check_run" | "code_scanning_alert.fixed">`.