github-webhook-relay-cli v1.0.1

github-webhook-relay-cli

CLI to receive webhooks from a GitHub repository via WebSocket and forward them to your localhost server

Warning
Receiving webhooks via websockets is currently in private beta

A Node.js CLI App that is using the github-webhook-relay module and is implementing the same features as the gh webhook plugin for the GitHub CLI.

Usage

Forward all issues and pull_request webhook events from the monalisa/octocat repository to http://localhost:3000/api/github/webhooks:

npx github-webhook-relay-cli \
  --token $GITHUB_TOKEN \
  --repo monalisa/hello-world \
  --events issues,pull_request \
  --url http://localhost:3000/api/github/webhooks

Required. Access token to create the repository webhook. The token needs to have the admin:repo_hook scope. (create a personal access token).

Required. The full repository name in the format owner/repo.

Required. a comma separated list of webhook events. See GitHub docs for a list of all events.

Required. The full URL to forward the webhook events to. The quests will be sent as POST requests.

The secret used to sign the webhook payloads. Defaults to no secret.

License

ISC