event-handler

event-handler

If you implement the route to receive webhook events from GitHub yourself then you can use the event-handler as a standalone module

Example

const { createEventHandler } = require('@octokit/webhooks')
const eventHandler = createEventHandler({
  async transform (event) {
    // optionally transform passed event before handlers are called
    return event
  }
})
eventHandler.on('installation', asyncInstallationHook)

// put this inside your webhooks route handler
eventHandler.receive({
  id: request.headers['x-github-delivery'],
  name: request.headers['x-github-event'],
  payload: request.body
}).catch(handleErrorsFromHooks)

🚨 Verify events

If you receive events through a publicly accessible URL, make sure to verify that the event request is coming from GitHub:

import { verify } from '@octokit/webhooks';
const secret = 'mysecret'

if (!verify(secret, request.payload, request.headers['x-hub-signature'])) {
  throw new Error('Signature does not match event payload & secret')
}

API

The event-handler API implements .receive(), .on() and .removeListener().

Back to @octokit/webhooks README.