Unthread Discord Bot 🤖

The Unthread Discord Bot is a powerful tool designed to streamline support ticket creation and management within Discord servers. By using simple commands, users can easily create support tickets, which are then managed through the Unthread platform. This bot integrates seamlessly with Discord and Unthread, providing a smooth and efficient support experience for both users and administrators.

✨ Key Features

• Create support tickets using the /support command.
• Automatically create support tickets from posts in specific forum channels.
• Easy setup and configuration through the Discord Developer Portal.
• Integration with Unthread for advanced ticket management.
• Customizable environment settings for personalized bot behavior.

🕹️ Usage

Use /support command to create a support ticket.

📦 Installation

1. Create a Discord Application

1. Go to the Discord Developer Portal.
2. Click on the "New Application" button.
3. Give your application a name and click "Create".

2. Setup Application Bot

1. In your newly created application, navigate to the "Bot" tab.
2. Click on the "Add Bot" button and confirm by clicking "Yes, do it!".
3. Under the "TOKEN" section, click "Copy" to copy your bot token. You will need this later.
4. Under "Privileged Gateway Intents", enable the "Message Content Intent".

3. Add the Bot to Your Discord Server

1. Navigate to the "OAuth2" tab and then to the "URL Generator" sub-tab.
2. Under "SCOPES", select bot and applications.commands.
3. Under "BOT PERMISSIONS", select the necessary permissions for your bot.
4. Use the following link to invite your bot to your server. Replace YOUR_BOT_CLIENT_ID with your actual bot client ID: https://discord.com/oauth2/authorize?client_id=YOUR_BOT_CLIENT_ID&permissions=1084479760448&integration_type=0&scope=bot+applications.commands

4. Fill Out the Environment Files

1. Create a .env file in the root directory of your project.
2. Copy the contents of .env.example to .env.
3. Fill in the required information:
   • DISCORD_BOT_TOKEN: The token you copied from the "Bot" tab.
   • CLIENT_ID: Your application's client ID, found in the "General Information" tab.
   • GUILD_ID: The ID of the Discord server where you want to deploy the bot. How to Get Your Discord Server ID
   • UNTHREAD_API_KEY: Your Unthread API key.
   • UNTHREAD_TRIAGE_CHANNEL_ID: Your Unthread triage channel ID.
   • UNTHREAD_EMAIL_INBOX_ID: Your Unthread email inbox ID.
   • UNTHREAD_WEBHOOK_SECRET: Your Unthread webhook secret.

5. Install and Run the Project Locally

1. Clone the repository and navigate to the project directory.
2. Install the dependencies:

yarn install

3. Start the bot:

yarn start

4. The bot should now be running in your Discord server.

6. Port Forwarding for Webhook

1. Open your project in VS Code.
2. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on Mac).
3. Type Ports: Focus on Ports View and select it.
4. In the Ports view, click on the + icon to add a new port.
5. Enter 3000 as the port number and press Enter.
6. Click on the globe icon next to the port to make it publicly accessible.

7. Configure Webhook in Unthread Dashboard

1. Log in to your Unthread dashboard.
2. Navigate to the "Settings" section.
3. Under "Webhook Configuration", enter the following URL:

http://<YOUR_PUBLIC_URL>:3000/webhook/unthread

Replace `<YOUR_PUBLIC_URL>` with the public URL provided by VS Code.

4. Save the settings.

Your bot should now be able to receive events from Unthread.

8. Configure Forum Channels

To enable automatic ticket creation from forum posts:

1. Add forum channel IDs to your .env file:

   FORUM_CHANNEL_IDS=123456789012345678,234567890123456789
   

2. Each comma-separated ID represents a forum channel that will be monitored.
3. Any new forum posts in these channels will automatically create a corresponding ticket in Unthread.
4. Replies in the forum post will be synchronized with the Unthread ticket.

How to Get Your Discord Server ID

1. Open Discord and go to your server.
2. Click on the server name at the top of the channel list to open the dropdown menu.
3. Select "Server Settings".
4. In the "Server Settings" menu, go to the "Widget" tab.
5. Enable the "Server Widget" option if it is not already enabled.
6. The "Server ID" will be displayed under the "Widget" settings.

Alternatively, you can enable Developer Mode to get the server ID:

1. Go to your Discord user settings.
2. Navigate to the "Advanced" tab under "App Settings".
3. Enable "Developer Mode".
4. Right-click on your server name in the server list.
5. Select "Copy ID" to copy the server ID to your clipboard.

🎯 Contributing

Contributions are welcome, create a pull request to this repo and I will review your code. Please consider to submit your pull request to the dev branch. Thank you!

Read the project's contributing guide for more info.

🐛 Issues

Please report any issues and bugs by creating a new issue here, also make sure you're reporting an issue that doesn't exist. Any help to improve the project would be appreciated. Thanks! 🙏✨

🙏 Sponsor

Like this project? Leave a star! ⭐⭐⭐⭐⭐

Want to support my work and get some perks? Become a sponsor! 💖

Or, you just love what I do? Buy me a coffee! ☕

Recognized my open-source contributions? Nominate me as GitHub Star! 💫

📋 Code of Conduct

Read the project's code of conduct.

📃 License

This project is licensed under GNU General Public License v3.0.

📝 Author

This project is created by Waren Gonzaga under WG Technology Labs, with the help of awesome contributors.

---

💻 with ❤️ by Waren Gonzaga and Him 🙏