Skip to content

feat(notifications): add ntfy markdown formatting #2602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
v3DJG6GL wants to merge 9 commits into
base: develop
Choose a base branch
from
Open

feat(notifications): add ntfy markdown formatting #2602

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
02f16c0
ntfy: add markdown formatting
v3DJG6GL Feb 28, 2026
95e15a5
fix: Comment branch drops payload.message
v3DJG6GL Mar 2, 2026
8a7230a
fix: Leading blank lines when message is empty
v3DJG6GL Mar 2, 2026
b994149
fix: Leading blank lines when message is empty
v3DJG6GL Mar 2, 2026
8ee7789
fix: Escape displayName for markdown injection
v3DJG6GL Mar 2, 2026
2306d0a
fix: also escape ~ and <
v3DJG6GL Mar 2, 2026
d8ee642
Merge branch 'seerr-team:develop' into ntfy-markdown
v3DJG6GL Mar 2, 2026
18e930a
fix: renamed payload.message label from "Comment" to "Description"
v3DJG6GL Mar 2, 2026
ec60fe8
also escape [
v3DJG6GL Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions server/lib/notifications/agents/ntfy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ class NtfyAgent
return settings.notifications.agents.ntfy;
}

private escapeMarkdown(text: string): string {
return text.replace(/([\\`*_{}\[\]()#+\-.!|>~<])/g, '\\$1');
}

private buildPayload(type: Notification, payload: NotificationPayload) {
const settings = getSettings();
const { applicationUrl } = settings.main;
Expand All @@ -35,7 +39,10 @@ class NtfyAgent
let message = payload.message ?? '';

if (payload.request) {
message += `\n\nRequested By: ${payload.request.requestedBy.displayName}`;
if (message) {
message = `**- Description:**\n${message}`;
}
message += `${message ? '\n\n' : ''}**- Requested By:** ${this.escapeMarkdown(payload.request.requestedBy.displayName)}`;

let status = '';
switch (type) {
Expand All @@ -58,14 +65,21 @@ class NtfyAgent
}

if (status) {
message += `\nRequest Status: ${status}`;
message += `\n**- Request Status:** ${status}`;
}
} else if (payload.comment) {
message += `\nComment from ${payload.comment.user.displayName}:\n${payload.comment.message}`;
if (message) {
message = `**- Description:**\n${message}\n\n`;
}
message += `**- Comment:**\n${payload.comment.message}`;
message += `\n\n**- Comment from:** ${this.escapeMarkdown(payload.comment.user.displayName)}`;
} else if (payload.issue) {
message += `\n\nReported By: ${payload.issue.createdBy.displayName}`;
message += `\nIssue Type: ${IssueTypeName[payload.issue.issueType]}`;
message += `\nIssue Status: ${
if (message) {
message = `**- Description:**\n${message}`;
}
message += `${message ? '\n\n' : ''}**- Reported By:** ${this.escapeMarkdown(payload.issue.createdBy.displayName)}`;
message += `\n**- Issue Type:** ${IssueTypeName[payload.issue.issueType]}`;
message += `\n**- Issue Status:** ${
payload.issue.status === IssueStatus.OPEN ? 'Open' : 'Resolved'
}`;
}
Expand All @@ -86,6 +100,7 @@ class NtfyAgent
priority,
title,
message,
markdown: true,
attach,
click,
};
Expand Down
Loading