Code Monkey home page Code Monkey logo

express-middleware-github-webhooks's Introduction

express-middleware-github-webhooks

Express middleware for handling post requests from GitHub's webhooks.

Getting started

Install with npm install -S express-middleware-github-webhooks

You must ensure that the post body is parsed before using this middleware, preferably with body-parser.

All requests are verified for authenticity. In addition, the property below is exposed for convenience:

req.githubWebhook = {
  headers: {
    event,
    signature,
    deliveryId,
  },
  body: req.body
};

How to use

This middleware must be called with a single object argument containing the following props:

MANDATORY
secret {string} The secret defined in the repo's webhook settings

OPTIONAL
whitelistEvents {array} An array of strings that match github webhook events. If this argument is passed, only these events will pass through the middleware.

Example

const expressWebhookMiddleware = require('express-middleware-github-webhooks');

const webhook = expressWebhookMiddleware({
  secret: process.env.YOUR_SECRET_HERE
});

module.exports = app => {
  // NOTE: Make sure the post body has been parsed and is available @ req.body
  app.post('/webhook', webhook, (req, res) => {
  	// req.githubWebhook is available in scope
    console.log(req.githubWebhook);
  });
};

express-middleware-github-webhooks's People

Contributors

andrewwalsh avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.