koa-github-hook-handler

handle github/gitea/bitbucket requests

import Koa from "koa";
import Router from "koa-better-router";
import { createGithubHookHandler } from "koa-github-hook-handler";

...

const router = Router();
const secret = "...";

router.addRoute(
  "POST",
  "/hook",
  createGithubHookHandler(
    {
      push: async request => {
        console.log("PUSH",request);
        return { ok: true };
      }
    },
    { secret }
  )
);

API

Table of Contents

• Context
• KoaHandler
  • Parameters
• WebhookHandler
  • Parameters
• createGithubHookHandler
  • Parameters
• createGiteaHookHandler
  • Parameters
• createBitbucketHookHandler
  • Parameters

Context

Type: Object

KoaHandler

Type: Function

Parameters

• ctx Context
• next Function

WebhookHandler

Type: Function

Parameters

• request Object decoded request body
• event string from 'x-github-event' header
• ctx Context from koa

createGithubHookHandler

Create a koa middleware suitable to bridge github webhook requests to KoaHandlers

Parameters

• actions Object holding all the handles for the events (event is the key)

  • actions.default Function default action
  • actions.event WebhookHandler (event is the key)

• config Object

  • config.secret string to decode signature

Returns KoaHandler suitable as koa middleware

createGiteaHookHandler

Create a koa middleware suitable to bridge gitea webhook requests to KoaHandlers

Parameters

• actions Object holding all the handles for the events (event is the key)

  • actions.default Function default action
  • actions.event WebhookHandler (event is the key)

• config Object

  • config.secret string to decode signature

Returns KoaHandler suitable as koa middleware

createBitbucketHookHandler

Create a koa middleware suitable to bridge gitea webhook requests to KoaHandlers

Parameters

• actions Object holding all the handles for the events (event is the key)

  • actions.default Function default action
  • actions.event WebhookHandler (event is the key)

• config Object

  • config.secret string to decode signature

Returns KoaHandler suitable as koa middleware

install

With npm do:

npm install koa-github-hook-handler

license

BSD-2-Clause