Discord Bot Documentation

GitTrack Documentation

Everything you need to seamlessly integrate GitHub with Discord. Get real-time notifications, manage repositories, and keep your team synchronized with your development workflow.

What is GitTrack?

GitTrack is a powerful Discord bot that bridges your GitHub repositories with your Discord server. Get real-time notifications for pushes, pull requests, issues, releases, and workflow runs directly in your Discord channels. With advanced branch pattern matching and flexible configuration options, GitTrack keeps your team synchronized with your development workflow.

Installation

Get GitTrack up and running in your Discord server in minutes

Add GitTrack to Discord

Ready to get started? Add GitTrack to your Discord server with one click.

Click the button below to add GitTrack to your Discord server with all the required permissions automatically configured.

Quick Setup Guide

1
Run /setup from your project channel

Connect the GitHub repository and choose the default channel where non-branch activity lands. The bot replies with the webhook payload URL and secret you will paste into GitHub.

/setup repository:https://github.com/your-org/your-repo channel:#notifications
2
Finish the GitHub webhook

In GitHub, go to Settings → Webhooks → Add webhook and use the response from /setup.

Payload URL: https://your-domain.com/github-webhookSecret: <copied from /setup>

Set Content type = application/json and choose "Send me everything".

3
Link branches or wildcard patterns

Route production, release, or feature prefixes into their own channels. Wildcards let you cover whole prefixes at once.

/link url:https://github.com/your-org/your-repo branch:release/* channel:#deploys
4
Route events & fine-tune filters

Use event commands to move issues, releases, stars, and other non-branch events into dedicated channels and toggle which actions alert your team.

/set-event-channel repository:<repo> event:issues channel:#triage
/edit-event repository:<repo> event:issues

Tip: Use /status anytime to review active repositories, limits, branches, and event routes.

Commands Reference

Complete list of all available GitTrack commands and their usage

Setup Commands

Configure GitTrack for your server and manage repository connections

/setup repository:<url> [channel]

Register a GitHub repository, pick a default notification channel, and generate the webhook secret + payload URL.

Parameters

Required
repository(String)

Full GitHub repository URL (https://github.com/org/repo)

Optional
channel(Channel)

Default channel for repository-wide notifications

/set-default-channel repository:<repo> channel:<channel>

Update where general (non-branch) notifications for a repository are delivered.

Parameters

Required
repository(String)

Select from repositories configured with /setup

Required
channel(Channel)

New default channel for the repository

/link url:<repo> branch:<pattern> channel:<channel>

Route branch-specific activity (pushes, PRs, etc.) into a Discord channel. Supports exact branches and wildcard patterns.

Parameters

Required
url(String)

Repository to link (autocomplete supported)

Required
branch(String)

Branch name or wildcard pattern (main, release/*, *)

Required
channel(Channel)

Channel that should receive these branch events

/unlink url:<repo> branch:<pattern> [channel]

Remove a branch or pattern link. Optionally scope the removal to a specific channel.

Parameters

Required
url(String)

Repository to update

Required
branch(String)

Branch or wildcard pattern to unlink

Optional
channel(Channel)

Only remove the mapping from this channel

/remove-repo url:<repo>

Delete a repository from the server along with every branch link and event override.

Parameters

Required
url(String)

Repository URL you want to remove entirely

/reset confirm:true

Danger zone. Clears all GitTrack data for the current server after explicit confirmation.

Parameters

Required
confirm(Boolean)

Must be set to true to run the reset

Event Routing & Filters

Control where non-branch GitHub events are delivered and which actions trigger alerts.

/set-event-channel repository:<repo> event:<type> channel:<channel>

Send non-branch GitHub events (issues, releases, stars, etc.) to a dedicated channel.

Parameters

Required
repository(String)

Repository whose events you want to route

Required
event(Choice)

Pick from issues, pull_request, release, star, fork, create, delete, milestone

Required
channel(Channel)

Destination channel for the selected event

/remove-event-channel repository:<repo> event:<type>

Remove an event override so it falls back to the repository default channel.

Parameters

Required
repository(String)

Repository to modify

Required
event(Choice)

Event route to remove

/edit-event repository:<repo> event:<type>

Interactively toggle which actions inside an event should alert (e.g., only opened/closed issues).

Parameters

Required
repository(String)

Repository to configure

Required
event(Choice)

Event whose action filters you want to edit

📊Information Commands

/status

View every tracked repository, branch pattern, event route, and the current server limits.

/help

Show the in-Discord help center with command usage and tips.

/ping

Simple health check to confirm the bot is online.

Branch Pattern Matching

GitTrack supports powerful wildcard patterns for branch tracking, making it easy to monitor groups of related branches without having to configure each one individually.

🎯 Supported Patterns

All Branches

*

Tracks all branches in the repository

Exact Branch Name

main

Tracks only the specified branch

Prefix Matching

features/*

Tracks all branches starting with "features/"

💡 Common Use Cases

features/*

All feature branches

hotfix/*

All hotfix branches

release/*

All release branches

main

Production branch only

⚠️Pattern Rules

  • • Wildcards are limited to a standalone * or a single trailing * at the end of a prefix (e.g., release/*).
  • • Branch names are case-sensitive and must match exactly what GitHub sends in the webhook.
  • • Allowed characters: letters, numbers, hyphens, underscores, dots, and forward slashes.
  • • Multiple patterns can overlap. If two patterns match the same push, GitTrack delivers both notifications.

Permissions & Limits

🔐Discord Permissions

To use GitTrack setup and configuration commands, you must have theManage Webhooks permission in your Discord server.

Note: Information commands like /status, /help, and /ping can be used by any server member.

📈Server Limits & Capacity

Each Discord server can register up to 10 repositories by default. Branch notification channels are unlimited unless a custom MAX_NOTIFICATION_CHANNELS_ALLOWED is configured.

Run /status to see current usage and limits. Remove unused entries with /remove-repo or /unlink before adding new ones.

Need more capacity? Email support@gittrack.me.

Troubleshooting

🚨 Common Issues

Bot not receiving webhooks

  • • Verify webhook URL is correct and accessible
  • • Check webhook secret matches the one from /setup
  • • Review GitHub webhook delivery logs

Notifications not appearing in Discord

  • • Check bot has Send Messages permission in target channel
  • • Verify channel is properly linked using /status
  • • Ensure branch patterns match the pushed branch
  • • Check if repository is properly configured

Branch autocomplete not working

  • • Public repos: Should work automatically
  • • Private repos: Requires manual typing or GitHub token
  • • Check repository URL is correct and accessible

💡Getting Help

If you're still experiencing issues after checking the troubleshooting guide:

• Use /status to check your configuration

• Use /help for command usage

• Join our support Discord server for assistance

• Check the GitHub webhook delivery logs for error details