Inviting Onyx to your Discord server

Inviting Onyx to your Discord server

How you connect Onyx to your Discord server depends on your plan. Hobby (free) users use the shared Onyx bot. Paid plan users bring their own Discord bot.

Before you start

• You must be logged into the Onyx dashboard
• You must have Manage Server permission (or be the owner) in the Discord server you want to connect

Hobby plan — Shared bot

Onyx handles the invite for you through a standard Discord OAuth flow.

1. In the Onyx dashboard, go to Configuration.
2. Click Connect Discord Server.
3. You'll be redirected to Discord. Select the server you want to connect and click Authorize.
4. You'll be redirected back to the Onyx dashboard.
5. Select the channel(s) you want Onyx to monitor under Support Channels.

The shared Onyx bot is now active in your server. It will appear in your member list as "Onyx."

Paid plans — Custom bot

On Starter, Growth, and Scale plans, you use your own Discord bot application. You need to set up and invite your bot before connecting through the dashboard.

1. Create your Discord application

1. Go to the Discord Developer Portal and create a new application.
2. Under the Bot tab, create a bot user. Set its username and upload an avatar.
3. Under Privileged Gateway Intents, enable Message Content Intent. This is required — without it, the bot cannot read messages.
4. Copy the bot Token.

2. Configure Onyx

1. In the Onyx dashboard, go to Configuration.
2. Enter your bot Token. Onyx will validate it automatically.
3. Once validated, your token is saved securely.

3. Invite your bot to your server

Generate an OAuth2 invite URL for your bot from the Discord Developer Portal (under OAuth2 → URL Generator) and use it to invite your bot to your server. Your bot must be a member of the server before Onyx can use it.

4. Connect your server

1. Back in the Onyx dashboard, click Connect Discord Server.
2. Authorize via the Discord OAuth flow.
3. Select the channel(s) you want Onyx to monitor.

Your bot is now active.

If this server previously used the shared Onyx bot, remove it from your member list so only your custom bot is active in the server.