Schlub — GitHub → Discord Webhooks (Enhanced)

A better GitHub webhook for Discord: beautiful embeds, extensive event coverage, and powerful v2 visual output.

✨ Features

• 🎨 Beautiful v2 Embeds — Emoji-enhanced titles, metadata fields, action buttons
• 📦 15+ Event Types — Push, PR, Issues, Releases, Workflows, Deployments, and more
• 🔄 API Versioning — /v1 (legacy) and /v2 (enhanced) endpoints
• ⚡ Cloudflare Workers — Fast, global edge deployment
• 🛡️ Rate Limiting — Built-in anti-spam for star/watch events
• 📱 Thread Support — Post to Discord forum threads

🚀 Quick Start

1. Get Your Discord Webhook

Copy your Discord webhook URL:

https://discord.com/api/webhooks/{webhookId}/{webhookToken}

2. Add GitHub Webhook

In your repository settings, add a webhook with:

• Payload URL: https://schlub.star-dev.xyz/v2/{webhookId}/{webhookToken}
• Content type: application/json
• Events: Select the events you want

3. Done! 🎉

Your GitHub events will now appear as beautiful embeds in Discord.

---

📋 Supported Events

Event	Description	v2 Enhancements
push	Commits pushed	📤 Files breakdown, force push warning
pull_request	PRs opened/closed/merged	🔀 Status colors, reviewers, labels
issues	Issues opened/closed	📋 Labels, assignees, milestones
release	Releases published	🎉 Assets, download buttons
workflow_run	CI/CD completed	✅ Duration, logs link
pull_request_review	PR reviews	📝 Approval status
discussion	Discussions	💬 Category, answer link
deployment_status	Deployments	🚀 Environment, status
star	Stars	⭐ Anti-spam cooldown
fork	Forks	🍴 Fork link
repository	Repo events	📁 Created, renamed, etc.

📖 Full event documentation →

---

🔗 URL Formats

# v2 (recommended) — Enhanced embeds
https://schlub.star-dev.xyz/v2/{webhookId}/{webhookToken}

# v1 (legacy) — Simple embeds
https://schlub.star-dev.xyz/v1/{webhookId}/{webhookToken}

# With thread support
https://schlub.star-dev.xyz/v2/{webhookId}/{webhookToken}?thread_id={threadId}

---

💻 Local Development

# Install dependencies
npm ci

# Start local server
npx wrangler dev

# Run type checking
npm run typecheck

# Deploy to Cloudflare
npm run deploy

---

📚 Documentation

• 📖 Main Documentation
• 📋 Supported Events
• ⚙️ Configuration Guide
• 🎨 V2 Embed Examples

---

🛠️ Project Status

• ✅ API versioning: /v1 and /v2
• ✅ 15+ event types supported
• ✅ Enhanced v2 embeds with emojis, fields, buttons
• ✅ KV namespaces for rate limiting
• ✅ Deployed: https://schlub.star-dev.xyz
• ✅ Comprehensive documentation

---

🤝 Credits & Attribution

Schlub was originally created by jackmthws Original repository → https://github.com/jackmthws/schlub

This project is now actively maintained and enhanced by Eministar.

Notable Enhancements

• 🎨 Beautiful v2 embed layouts with emojis and buttons
• 📦 5 new event types (release, workflow_run, PR review, discussion, deployment)
• 📖 Comprehensive documentation
• 🔧 Extended embed utilities
• ⚡ Improved code quality and TypeScript types

---

📄 License

GNU License — Feel free to use, modify, and distribute.