Introduction

What is Octoflow?

Octoflow is a Discord bot that bridges your GitHub repositories to your Discord server. When activity happens in a repository a push, a pull request, a new issue, or even a deployment Octoflow sends a rich notification to the channel of your choosing.

It's built on top of GitHub's webhook system. You point a GitHub webhook at the Octoflow API, tell the bot which repository goes to which channel, and events start flowing.

Key Concepts

Webhooks — An Octoflow webhook is a record that ties your Discord server to the Octoflow API. You create one with /newhook, receive a URL and secret, then register that URL in GitHub. One webhook supports multiple repositories. Each guild can have up to 5 webhooks.

Repositories — A repository entry links a GitHub repo to a specific Discord channel within a webhook. When GitHub fires an event for that repo, Octoflow routes it to the configured channel. Run /newrepo to add one.

Event Modifiers — Fine-grained rules that let you whitelist or blacklist specific GitHub event types, or redirect events to a different channel. Each webhook supports up to 10 event modifiers.

Backups — Export your entire webhook configuration (repos + event modifiers) to a portable JSON file and restore it later with /restore.

Getting Started

Command Reference