mirror of https://github.com/ReCloudStudio/WebHooker.git synced 2026-09-23 00:21:28 +00:00

docs: align VitePress site with REST send, optional gateway and slash commands

- deployment: drop DISCORD_CHANNEL_ID, add ADMIN_USER_IDS, PKCS#8 key note,
  applications.commands invite scope, and an optional Gateway section
- getting-started: PKCS#8 .dev.vars example, remove channel ID
- introduction: REST delivery, optional DiscordGateway DO, delivery dedup,
  /admin Web UI in architecture and data flow
- index: refresh Workers feature, add Web UI & slash commands feature

2026-08-02 07:02:40 +08:00

2.7 KiB

Raw Blame History

Introduction

WebHooker is a GitHub webhook dispatcher built on Cloudflare Workers. It receives GitHub webhook events, applies configurable filters, formats them into rich Discord embeds, and delivers them to Discord channels or threads through the Discord REST API. An optional Durable Object holds a Gateway connection to keep the bot online and power the in-Discord /gh commands. Routes are managed through a built-in Web UI.

Architecture

GitHub Webhook → Cloudflare Worker (Hono)
                 ├── POST /webhook → verify → dedup → filter → format → Discord (REST API)
                 ├── GET  /auth/github → OAuth flow
                 ├── POST /api/* → user actions (Bearer token auth)
                 ├── /admin → routes & send-log Web UI (admin session)
                 └── GET  /health → status check

(optional) Durable Object ⇄ Discord Gateway  →  bot online + /gh slash & context commands

Components

Component	Role
Cloudflare Worker	HTTP ingress, signature verification, delivery dedup, event parsing, route matching, REST send
Durable Object (DiscordGateway)	Optional. Keeps the Gateway connection alive (bot online) and handles `/gh` interactions
KV	Token storage (`token:{userId}`), OAuth state (`state:{hex}`), route config (`config:routes`), send logs, delivery dedup

Data Flow

GitHub sends a webhook to POST /webhook
Worker verifies the HMAC-SHA256 signature
Worker deduplicates by X-GitHub-Delivery (KV, short TTL) to drop repeat deliveries
Worker parses the event type and payload
Routes are evaluated against filters (event, repo, actor, action, branch, keyword)
Matching routes trigger formatter functions that produce Discord embeds
Each message is sent to its route's target channel/thread via the Discord REST API with rate-limit retry, and the result is recorded in the send log

Tech Stack

Runtime: Cloudflare Workers
HTTP Framework: Hono
Discord delivery: Discord REST API (Gateway via optional Durable Object for online status + /gh commands)
Web UI: Nuxt 3 static SPA served from Worker assets
Storage: Cloudflare KV
Auth: Web Crypto API (HMAC-SHA256), jose (JWT), octokit (GitHub API)
Language: TypeScript

License

MIT

2.7 KiB Raw Blame History