Github Webhooks handler based on Node.js. Support multiple handlers.
Switch branches/tags
Nothing to show
Clone or download
Latest commit a0d72f2 Jun 13, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs [fix] fix readme type Jun 14, 2017
.gitignore init Jan 19, 2017
LICENSE Initial commit Jan 19, 2017
README.md [fix] fix readme type Jun 14, 2017
index.js remv useless check Jan 22, 2017
package.json 1.0.8 Jun 14, 2017
yarn.lock init repo Jan 19, 2017

README.md

node-github-webhook

Github Webhooks handler based on Node.js. Support multiple handlers.

Language

Instructions

This library is inspired by github-webhook-handler, and it allows you set multiple handlers for different repositories.

It is a small tool based on Node.js to help you handler all the logic for receiving and verifying webhook requests from GitHub.

If you want to know the events of Github, please see: events.

Notice: Github Webhooks setting: Content-type must be application/json.

Installation

npm install node-github-webhook --save

Usage

var http = require('http')
var createHandler = require('node-github-webhook')
var handler = createHandler([ // multiple handlers
  { path: '/webhook1', secret: 'secret1' },
  { path: '/webhook2', secret: 'secret2' }
])
// var handler = createHandler({ path: '/webhook1', secret: 'secret1' }) // single handler

http.createServer(function (req, res) {
  handler(req, res, function (err) {
    res.statusCode = 404
    res.end('no such location')
  })
}).listen(7777)

handler.on('error', function (err) {
  console.error('Error:', err.message)
})

handler.on('push', function (event) {
  console.log(
    'Received a push event for %s to %s',
    event.payload.repository.name,
    event.payload.ref
  )
  switch(event.path) {
    case '/webhook1':
      // do sth about webhook1
      break
    case '/webhook2':
      // do sth about webhook2
      break
    default:
      // do sth else or nothing
      break
  }
})