HoloBridge Documentation

A type-safe TypeScript bridge between websites and Discord bots. Provides a REST API and WebSocket interface for full Discord bot capabilities.

Quick Start

• Getting Started - Installation, configuration, and running the server
• API Reference - Complete REST API endpoint documentation
• WebSocket Events - Real-time event streaming documentation
• Plugins - Create plugins with event handling and REST endpoints
• Security - API scopes, rate limiting, and security features
• Network Configuration - Expose your API on the local network

Features

🌐 REST API

Full REST API for all Discord operations including guilds, channels, messages, members, and roles.

⚡ WebSocket Events

Real-time event streaming via Socket.IO. Subscribe to guilds and receive Discord events instantly.

🔒 Type-Safe

Built with TypeScript and Zod validation. Every request and response is fully typed.

📦 Full Coverage

Guilds, Channels, Roles, Members, Bans, Timeouts, Messages, Reactions, Pins, and more.

🔌 Plugin System

Extend functionality with plugins. Add routes, listen to events, and communicate between plugins.

🌍 Network Exposed API

Bind to 0.0.0.0 to expose the API on your local network for access from other devices.

Discord Operations

• Guilds - List guilds, get details, channels, roles, emojis, bans, invites
• Channels - Create, edit, delete channels and threads
• Messages - Send, edit, delete, bulk delete, reactions, pins
• Members - List, search, kick, ban, timeout, role management
• Roles - Create, edit, delete, permissions management

Real-Time Events

• Message Events - messageCreate, messageUpdate, messageDelete
• Member Events - guildMemberAdd, guildMemberRemove, guildMemberUpdate
• Channel Events - channelCreate, channelUpdate, channelDelete
• Role Events - roleCreate, roleUpdate, roleDelete
• Voice Events - voiceStateUpdate
• Guild Events - guildBanAdd, guildBanRemove
• And 40+ more - See the WebSocket documentation for the full list

API Endpoints Overview

License

HoloBridge © 2025 - MIT License