Dokploy / Dokploy/dokploy

Add discord role mentions for error notifications

Open
#2,803 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
37.4k
Forks
3k
Avg merge
1d 3h
Merged PRs (30d)
73

Description

What problem will this feature address?

Currently, when Discord webhook notifications are sent for errors (build failures, server threshold alerts, etc.), they are posted as regular messages without the ability to mention specific roles or users. This means that critical error notifications might be missed by the relevant team members who need to respond quickly to incidents.

In production environments, it's crucial that error notifications immediately alert the right people (DevOps team, on-call engineers, etc.) by mentioning their Discord roles, ensuring they receive proper notifications even when they're not actively monitoring the channel.

Describe the solution you'd like

Add a new optional field to Discord notification configuration called "Error Role Mentions" that allows users to specify Discord role IDs that should be mentioned when error-type notifications are sent.

The implementation should include:
- Add a new input field in the Discord notification form (in the dashboard settings)
- Allow users to enter multiple Discord role IDs (format: <@&123456789> or just 123456789)
- Include helpful text explaining how to get Discord role IDs
- Only show role mentions for error-type notifications (build errors, server threshold alerts, etc.)

Describe alternatives you've considered
  1. Integration with Discord bot instead of webhooks: This would require more complex setup and authentication, while webhooks are simpler and already implemented.

  2. Separate notification channels for errors: While possible, this adds complexity and many teams prefer to have all notifications in one channel with appropriate mentions for urgent issues.

Additional context

Discord role mentions work by including <@&ROLE_ID> in the message content. The role ID can be obtained by:

  1. Enabling developer mode in Discord
  2. Right-clicking on the role and selecting "Copy ID"

Example of how the notification would look:

<@&123456789> <@&987654321>
[Embed with error details]

This feature would significantly improve incident response times by ensuring the right people are immediately notified of critical issues

Will you send a PR to implement it?

Maybe, need help

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Discord notification configuration form in the dashboard settings and the webhook path that sends error notifications. Trace how notification types are identified and how configuration is stored, then verify that configured role IDs appear only on error messages and that the form explains how to obtain them.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
backend, devops, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.