express-github-webhook
Express middleware to validate webhooks from GitHub
Install
npm install --save @inventivetalent/express-github-webhook
Basic Server Example
// Hello World Example from https://expressjs.com/en/starter/hello-world.html
const express = require('express')
const bodyParser = require('body-parser')
const {GithubWebhook} = require('@inventivetalent/express-github-webhook');
const app = express()
const port = 3000
app.use(bodyParser.json()) // Required for validating the request
// Register the puller middleware at the specified endpoint
const webhookHandler = new GithubWebhook({
events: ["push"], // Events to listen for (optional, since you can select them on Github as well - set to * to handle all events)
secret: "SuperSecretSecret" // Set this to verify the request against the secret provided to github
});
app.use("/_my_git_endpoint", webhookHandler.middleware, (req, res) => {
// Middleware validated the request and it's good to go at this point!
console.log("got valid github webhook!");
console.log(req.body);
});
app.get('/', (req, res) => res.send('Hello World!'))
app.listen(port, () => console.log(`Example app listening at http://localhost:${ port }`))Github Webhook Example
- Obviously use your project's public domain
- Set Content type to
application/json - (optional) Set a secret and add it to the puller config
- (optional) Choose which events should be sent to the webhook - also make sure to change the puller config respectively