express-github-webhook
A Express middleware for handle Github Webhooks
To Install:
npm install express-github-webhook
To Use:
Make sure you use body-parser middleware for your Express app
var GithubWebHook = ;var webhookHandler = ; // use in your express applet app = ;app; // must use bodyParser in expressapp; // use our middleware // Now could handle following eventswebhookHandler; webhookHandler; webhookHandler; webhookHandler;
Where 'event' is the event name to listen to (sent by GitHub, such as 'push'), 'reponame' is the name of your repo.
'error' event is a special event, which will be triggered when something goes wrong in the handler (like failed to verify the signature).
Available options for creating handler are:
- path: the path for the GitHub callback, only request that matches this path will be handled by the middleware.
- secret (option): the secret used to verify the signature of the hook. If secret is set, then request without signature will fail the handler. If secret is not set, then the signature of the request (if any) will be ignored. Read more
TODO
- Add support for content type of
application/x-www-form-urlencoded
- Provide more available options
- Get rid of
body-parser
middleware