Agent skill
GitHub Webhooks Skill
Receive and verify GitHub webhooks. Use when setting up GitHub webhook handlers, debugging signature verification, or handling repository events like push, pull_request, issues, or release.
Install this skill
npx skills add hookdeck/webhook-skills --skill github-webhooks
When to Use This Skill
- Setting up GitHub webhook handlers
- Debugging signature verification failures
- Understanding GitHub event types and payloads
- Handling push, pull request, or issue events
Verification (core)
GitHub signs the raw body with HMAC-SHA256 keyed on your webhook secret and sends the digest in X-Hub-Signature-256 formatted as sha256=<hex>. Use X-Hub-Signature-256 (not the legacy SHA-1 X-Hub-Signature), pass the raw body, and compare timing-safe.
Node:
const crypto = require('crypto');
function verify(rawBody, signatureHeader, secret) {
const [algo, sig] = (signatureHeader || '').split('=');
if (algo !== 'sha256' || !sig) return false;
const expected = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
try {
return crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(expected));
} catch {
return false;
}
}
Python:
import hmac, hashlib
def verify(raw_body: bytes, signature_header: str, secret: str) -> bool:
algo, _, sig = (signature_header or "").partition("=")
if algo != "sha256" or not sig:
return False
expected = hmac.new(secret.encode(), raw_body, hashlib.sha256).hexdigest()
return hmac.compare_digest(sig, expected)
For complete handlers with route wiring, event dispatch, and tests, see:
Common Event Types
| Event | Description |
|---|---|
push | Commits pushed to branch |
pull_request | PR opened, closed, merged, etc. |
issues | Issue opened, closed, labeled, etc. |
release | Release published |
workflow_run | GitHub Actions workflow completed |
ping | Test event when webhook created |
For full event reference, see GitHub Webhook Events
Important Headers
| Header | Description |
|---|---|
X-Hub-Signature-256 | HMAC SHA-256 signature (use this, not sha1) |
X-GitHub-Event | Event type (push, pull_request, etc.) |
X-GitHub-Delivery | Unique delivery ID |
Environment Variables
GITHUB_WEBHOOK_SECRET=your_webhook_secret # Set when creating webhook in GitHub
Local Development
# Start tunnel (no account needed)
npx hookdeck-cli listen 3000 github --path /webhooks/github
Reference Materials
- references/overview.md - GitHub webhook concepts
- references/setup.md - Configuration guide
- references/verification.md - Signature verification details