mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-05-28 09:32:31 +00:00
5ec2947d86
The Pushover webhook template now honors user-defined custom fields for sound, priority, and device. Previously, these fields were hardcoded based on alert level, ignoring any custom values set by users in the UI. Changes: - sound: Uses CustomFields.sound if provided, otherwise falls back to level-based default (critical=siren, warning=tugboat, else=pushover) - priority: Uses CustomFields.priority if provided, otherwise falls back to level-based default (critical=1, warning=0, else=-1) - device: Uses CustomFields.device if provided, otherwise falls back to ResourceName Updated setup instructions to document optional custom fields for sound, priority, and device configuration. This allows users to customize Pushover notification behavior without editing webhook templates, consistent with Pulse's maintainability goals.
331 lines
16 KiB
Go
331 lines
16 KiB
Go
package notifications
|
|
|
|
// WebhookTemplate represents a webhook template for popular services
|
|
type WebhookTemplate struct {
|
|
Service string `json:"service"`
|
|
Name string `json:"name"`
|
|
URLPattern string `json:"urlPattern"`
|
|
Method string `json:"method"`
|
|
Headers map[string]string `json:"headers"`
|
|
PayloadTemplate string `json:"payloadTemplate"`
|
|
Instructions string `json:"instructions"`
|
|
}
|
|
|
|
// GetWebhookTemplates returns templates for popular webhook services
|
|
func GetWebhookTemplates() []WebhookTemplate {
|
|
return []WebhookTemplate{
|
|
{
|
|
Service: "discord",
|
|
Name: "Discord Webhook",
|
|
URLPattern: "https://discord.com/api/webhooks/{webhook_id}/{webhook_token}",
|
|
Method: "POST",
|
|
Headers: map[string]string{"Content-Type": "application/json"},
|
|
PayloadTemplate: `{
|
|
"username": "Pulse Monitoring",
|
|
"embeds": [{
|
|
"title": "Pulse Alert: {{.Level | title}}",
|
|
"description": "{{.Message}}",
|
|
"color": {{if eq .Level "critical"}}15158332{{else if eq .Level "warning"}}15105570{{else}}3447003{{end}},
|
|
"fields": [
|
|
{"name": "Resource", "value": "{{.ResourceName}}", "inline": true},
|
|
{"name": "Node", "value": "{{.Node}}", "inline": true},
|
|
{"name": "Type", "value": "{{.Type | title}}", "inline": true},
|
|
{"name": "Value", "value": "{{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.1f" .Value}} MB/s{{else}}{{printf "%.1f" .Value}}%{{end}}", "inline": true},
|
|
{"name": "Threshold", "value": "{{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.0f" .Threshold}} MB/s{{else}}{{printf "%.0f" .Threshold}}%{{end}}", "inline": true},
|
|
{"name": "Duration", "value": "{{.Duration}}", "inline": true}
|
|
],
|
|
"timestamp": "{{.Timestamp}}",
|
|
"footer": {
|
|
"text": "Pulse Monitoring"
|
|
}
|
|
}]
|
|
}`,
|
|
Instructions: "1. In Discord, go to Server Settings > Integrations > Webhooks\n2. Create a new webhook and copy the URL\n3. Paste the URL here (format: https://discord.com/api/webhooks/...)",
|
|
},
|
|
{
|
|
Service: "telegram",
|
|
Name: "Telegram Bot",
|
|
URLPattern: "https://api.telegram.org/bot{bot_token}/sendMessage",
|
|
Method: "POST",
|
|
Headers: map[string]string{"Content-Type": "application/json"},
|
|
PayloadTemplate: `{
|
|
"chat_id": "{{.ChatID}}",
|
|
"text": "*Pulse Alert: {{.Level | title}}*\n\n{{.Message}}\n\n*Details:*\n• Resource: {{.ResourceName}}\n• Node: {{.Node}}\n• Type: {{.Type | title}}\n• Value: {{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.1f" .Value}} MB/s{{else}}{{printf "%.1f" .Value}}%{{end}}\n• Threshold: {{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.0f" .Threshold}} MB/s{{else}}{{printf "%.0f" .Threshold}}%{{end}}\n• Duration: {{.Duration}}\n\n[View in Pulse]({{.Instance}})",
|
|
"parse_mode": "Markdown",
|
|
"disable_web_page_preview": true
|
|
}`,
|
|
Instructions: "1. Create a bot with @BotFather on Telegram\n2. Get your bot token\n3. Get your chat ID by messaging the bot and visiting: https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates\n4. URL format: https://api.telegram.org/bot<BOT_TOKEN>/sendMessage?chat_id=<CHAT_ID>\n5. IMPORTANT: You MUST include ?chat_id=YOUR_CHAT_ID in the URL",
|
|
},
|
|
{
|
|
Service: "slack",
|
|
Name: "Slack Incoming Webhook",
|
|
URLPattern: "https://hooks.slack.com/services/{webhook_path}",
|
|
Method: "POST",
|
|
Headers: map[string]string{"Content-Type": "application/json"},
|
|
PayloadTemplate: `{
|
|
"text": "Pulse Alert: {{.Level | title}} - {{.ResourceName}}",
|
|
"blocks": [
|
|
{
|
|
"type": "header",
|
|
"text": {
|
|
"type": "plain_text",
|
|
"text": "Pulse Alert: {{.Level | title}}",
|
|
"emoji": true
|
|
}
|
|
},
|
|
{
|
|
"type": "section",
|
|
"text": {
|
|
"type": "mrkdwn",
|
|
"text": "{{.Message}}"
|
|
}
|
|
},
|
|
{
|
|
"type": "section",
|
|
"fields": [
|
|
{"type": "mrkdwn", "text": "*Resource:*\n{{.ResourceName}}"},
|
|
{"type": "mrkdwn", "text": "*Node:*\n{{.Node}}"},
|
|
{"type": "mrkdwn", "text": "*Type:*\n{{.Type | title}}"},
|
|
{"type": "mrkdwn", "text": "*Value:*\n{{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.1f" .Value}} MB/s{{else}}{{printf "%.1f" .Value}}%{{end}}"},
|
|
{"type": "mrkdwn", "text": "*Threshold:*\n{{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.0f" .Threshold}} MB/s{{else}}{{printf "%.0f" .Threshold}}%{{end}}"},
|
|
{"type": "mrkdwn", "text": "*Duration:*\n{{.Duration}}"}
|
|
]
|
|
},
|
|
{
|
|
"type": "context",
|
|
"elements": [
|
|
{
|
|
"type": "mrkdwn",
|
|
"text": "View in <{{.Instance}}|Proxmox> | Alert ID: {{.ID}}"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}`,
|
|
Instructions: "1. In Slack, go to Apps > Incoming Webhooks\n2. Add to Slack and choose a channel\n3. Copy the webhook URL and paste it here (format: https://hooks.slack.com/services/...)",
|
|
},
|
|
{
|
|
Service: "teams",
|
|
Name: "Microsoft Teams",
|
|
URLPattern: "https://{tenant}.webhook.office.com/webhookb2/{webhook_path}",
|
|
Method: "POST",
|
|
Headers: map[string]string{"Content-Type": "application/json"},
|
|
PayloadTemplate: `{
|
|
"@type": "MessageCard",
|
|
"@context": "http://schema.org/extensions",
|
|
"themeColor": "{{if eq .Level "critical"}}FF0000{{else if eq .Level "warning"}}FFA500{{else}}00FF00{{end}}",
|
|
"summary": "Pulse Alert: {{.Level | title}} - {{.ResourceName}}",
|
|
"sections": [{
|
|
"activityTitle": "Pulse Alert: {{.Level | title}}",
|
|
"activitySubtitle": "{{.Message}}",
|
|
"facts": [
|
|
{"name": "Resource", "value": "{{.ResourceName}}"},
|
|
{"name": "Node", "value": "{{.Node}}"},
|
|
{"name": "Type", "value": "{{.Type | title}}"},
|
|
{"name": "Value", "value": "{{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.1f" .Value}} MB/s{{else}}{{printf "%.1f" .Value}}%{{end}}"},
|
|
{"name": "Threshold", "value": "{{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.0f" .Threshold}} MB/s{{else}}{{printf "%.0f" .Threshold}}%{{end}}"},
|
|
{"name": "Duration", "value": "{{.Duration}}"},
|
|
{"name": "Instance", "value": "{{.Instance}}"}
|
|
],
|
|
"markdown": true
|
|
}],
|
|
"potentialAction": [{
|
|
"@type": "OpenUri",
|
|
"name": "View in Proxmox",
|
|
"targets": [{
|
|
"os": "default",
|
|
"uri": "{{.Instance}}"
|
|
}]
|
|
}]
|
|
}`,
|
|
Instructions: "1. In Teams channel, click ... > Connectors\n2. Configure Incoming Webhook\n3. Copy the URL and paste it here\n\nNote: MessageCard format is supported until December 2025. For new implementations, consider using Adaptive Cards.",
|
|
},
|
|
{
|
|
Service: "pagerduty",
|
|
Name: "PagerDuty Events API v2",
|
|
URLPattern: "https://events.pagerduty.com/v2/enqueue",
|
|
Method: "POST",
|
|
Headers: map[string]string{
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/vnd.pagerduty+json;version=2",
|
|
},
|
|
PayloadTemplate: `{
|
|
"routing_key": "{{.CustomFields.routing_key}}",
|
|
"event_action": "trigger",
|
|
"dedup_key": "{{.ID}}",
|
|
"payload": {
|
|
"summary": "{{.Message}}",
|
|
"timestamp": "{{.Timestamp}}",
|
|
"severity": "{{if eq .Level "critical"}}critical{{else if eq .Level "warning"}}warning{{else}}info{{end}}",
|
|
"source": "{{.Node}}",
|
|
"component": "{{.ResourceName}}",
|
|
"group": "{{.Type}}",
|
|
"class": "{{.Type}}",
|
|
"custom_details": {
|
|
"alert_id": "{{.ID}}",
|
|
"resource_type": "{{.Type}}",
|
|
"current_value": "{{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.1f" .Value}} MB/s{{else}}{{printf "%.1f" .Value}}%{{end}}",
|
|
"threshold": "{{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.0f" .Threshold}} MB/s{{else}}{{printf "%.0f" .Threshold}}%{{end}}",
|
|
"duration": "{{.Duration}}",
|
|
"instance": "{{.Instance}}"
|
|
}
|
|
},
|
|
"client": "Pulse Monitoring",
|
|
"client_url": "{{.Instance}}",
|
|
"links": [{
|
|
"href": "{{.Instance}}",
|
|
"text": "View in Proxmox"
|
|
}]
|
|
}`,
|
|
Instructions: "1. In PagerDuty, go to Configuration > Services\n2. Add an integration > Events API V2\n3. Copy the Integration Key\n4. Add the key as a custom field named 'routing_key'\n\nNote: PagerDuty recommends using Events API v2 for new integrations.",
|
|
},
|
|
{
|
|
Service: "teams-adaptive",
|
|
Name: "Microsoft Teams (Adaptive Card)",
|
|
URLPattern: "https://{tenant}.webhook.office.com/webhookb2/{webhook_path}",
|
|
Method: "POST",
|
|
Headers: map[string]string{"Content-Type": "application/json"},
|
|
PayloadTemplate: `{
|
|
"type": "message",
|
|
"attachments": [{
|
|
"contentType": "application/vnd.microsoft.card.adaptive",
|
|
"content": {
|
|
"type": "AdaptiveCard",
|
|
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
|
|
"version": "1.4",
|
|
"body": [
|
|
{
|
|
"type": "TextBlock",
|
|
"text": "Pulse Alert: {{.Level | title}}",
|
|
"weight": "Bolder",
|
|
"size": "Large",
|
|
"color": "{{if eq .Level "critical"}}Attention{{else if eq .Level "warning"}}Warning{{else}}Good{{end}}"
|
|
},
|
|
{
|
|
"type": "TextBlock",
|
|
"text": "{{.Message}}",
|
|
"wrap": true,
|
|
"spacing": "Small"
|
|
},
|
|
{
|
|
"type": "FactSet",
|
|
"facts": [
|
|
{"title": "Resource", "value": "{{.ResourceName}}"},
|
|
{"title": "Node", "value": "{{.Node}}"},
|
|
{"title": "Type", "value": "{{.Type | title}}"},
|
|
{"title": "Current Value", "value": "{{printf "%.1f" .Value}}%"},
|
|
{"title": "Threshold", "value": "{{printf "%.0f" .Threshold}}%"},
|
|
{"title": "Duration", "value": "{{.Duration}}"},
|
|
{"title": "Alert ID", "value": "{{.ID}}"}
|
|
]
|
|
}
|
|
],
|
|
"actions": [{
|
|
"type": "Action.OpenUrl",
|
|
"title": "View in Proxmox",
|
|
"url": "{{.Instance}}"
|
|
}]
|
|
}
|
|
}]
|
|
}`,
|
|
Instructions: "1. In Teams channel, click ... > Connectors\n2. Configure Incoming Webhook\n3. Copy the URL and paste it here\n\nThis uses the modern Adaptive Card format recommended for new implementations.",
|
|
},
|
|
{
|
|
Service: "pushover",
|
|
Name: "Pushover",
|
|
URLPattern: "https://api.pushover.net/1/messages.json",
|
|
Method: "POST",
|
|
Headers: map[string]string{"Content-Type": "application/json"},
|
|
PayloadTemplate: `{
|
|
"token": "{{.CustomFields.app_token}}",
|
|
"user": "{{.CustomFields.user_token}}",
|
|
"title": "Pulse Alert: {{.Level | title}} - {{.ResourceName}}",
|
|
"message": "{{.Message}}\n\n• Resource: {{.ResourceName}}\n• Node: {{.Node}}\n• Type: {{.Type | title}}\n• Value: {{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.1f" .Value}} MB/s{{else}}{{printf "%.1f" .Value}}%{{end}}\n• Threshold: {{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.0f" .Threshold}} MB/s{{else}}{{printf "%.0f" .Threshold}}%{{end}}\n• Duration: {{.Duration}}",
|
|
"priority": {{if .CustomFields.priority}}{{.CustomFields.priority}}{{else}}{{if eq .Level "critical"}}1{{else if eq .Level "warning"}}0{{else}}-1{{end}}{{end}},
|
|
"sound": "{{if .CustomFields.sound}}{{.CustomFields.sound}}{{else}}{{if eq .Level "critical"}}siren{{else if eq .Level "warning"}}tugboat{{else}}pushover{{end}}{{end}}",
|
|
"device": "{{if .CustomFields.device}}{{.CustomFields.device}}{{else}}{{.ResourceName}}{{end}}",
|
|
"timestamp": "{{.Timestamp}}"
|
|
}`,
|
|
Instructions: "1. Create an application at https://pushover.net/apps\n2. Copy your Application Token\n3. Get your User Key from your Pushover dashboard\n4. URL: https://api.pushover.net/1/messages.json\n5. Add custom fields:\n • app_token: YOUR_APP_TOKEN (required)\n • user_token: YOUR_USER_KEY (required)\n • sound: notification sound (optional, e.g., spacealarm, siren, tugboat)\n • priority: -2 to 2 (optional, overrides level-based default)\n • device: specific device name (optional, overrides ResourceName)",
|
|
},
|
|
{
|
|
Service: "gotify",
|
|
Name: "Gotify",
|
|
URLPattern: "https://{your-gotify-server}/message?token={your-app-token}",
|
|
Method: "POST",
|
|
Headers: map[string]string{"Content-Type": "application/json"},
|
|
PayloadTemplate: `{
|
|
"message": "**{{if eq .Level "critical"}}CRITICAL{{else if eq .Level "warning"}}WARNING{{else}}INFO{{end}}**: **{{.ResourceName}}** on **{{.Node}}**\n\n{{.Message}}\n\n**Alert Details:**\n- **Resource:** {{.ResourceName}}\n- **Node:** {{.Node}}\n- **Type:** {{.Type | title}}\n- **Current:** {{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.1f" .Value}} MB/s{{else}}{{printf "%.1f" .Value}}%{{end}}\n- **Threshold:** {{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.0f" .Threshold}} MB/s{{else}}{{printf "%.0f" .Threshold}}%{{end}}\n- **Duration:** {{.Duration}}\n- **Alert ID:** {{.ID}}\n\n[View in Pulse]({{.Instance}})",
|
|
"title": "{{.ResourceName}} - {{.Type | title}} {{.Level | upper}} Alert",
|
|
"priority": {{if eq .Level "critical"}}10{{else if eq .Level "warning"}}5{{else}}2{{end}},
|
|
"extras": {
|
|
"client::display": {
|
|
"contentType": "text/markdown"
|
|
},
|
|
"pulse::alert": {
|
|
"id": "{{.ID}}",
|
|
"level": "{{.Level}}",
|
|
"type": "{{.Type}}",
|
|
"resource_name": "{{.ResourceName}}",
|
|
"node": "{{.Node}}",
|
|
"value": {{.Value}},
|
|
"threshold": {{.Threshold}},
|
|
"duration": "{{.Duration}}",
|
|
"instance": "{{.Instance}}"
|
|
}
|
|
}
|
|
}`,
|
|
Instructions: "1. In Gotify, create a new application\n2. Copy the application token\n3. URL format: https://your-gotify-server/message?token=YOUR_APP_TOKEN\n4. The token must be included in the URL as a parameter",
|
|
},
|
|
{
|
|
Service: "ntfy",
|
|
Name: "ntfy.sh",
|
|
URLPattern: "https://ntfy.sh/{topic}",
|
|
Method: "POST",
|
|
Headers: map[string]string{
|
|
"Content-Type": "text/plain",
|
|
// Note: Title, Priority, and Tags headers should be added dynamically based on alert level
|
|
// For now, we'll use static reasonable defaults that won't break
|
|
},
|
|
PayloadTemplate: `{{if eq .Level "critical"}}CRITICAL{{else if eq .Level "warning"}}WARNING{{else}}INFO{{end}}: {{.ResourceName}} on {{.Node}}
|
|
|
|
{{.Message}}
|
|
|
|
Alert Details:
|
|
- Resource: {{.ResourceName}}
|
|
- Node: {{.Node}}
|
|
- Type: {{.Type | title}}
|
|
- Current: {{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.1f" .Value}} MB/s{{else}}{{printf "%.1f" .Value}}%{{end}}
|
|
- Threshold: {{if or (eq .Type "diskRead") (eq .Type "diskWrite")}}{{printf "%.0f" .Threshold}} MB/s{{else}}{{printf "%.0f" .Threshold}}%{{end}}
|
|
- Duration: {{.Duration}}
|
|
- Alert ID: {{.ID}}
|
|
|
|
View in Pulse: {{.Instance}}`,
|
|
Instructions: "1. Choose a topic name (e.g., 'my-pulse-alerts')\n2. URL format: https://ntfy.sh/YOUR_TOPIC\n Or for self-hosted: https://your-ntfy-server/YOUR_TOPIC\n3. For authentication, add a custom header:\n • Header Name: Authorization\n • Header Value: Bearer YOUR_TOKEN (or Basic base64_encoded_credentials)\n4. Subscribe to the topic in your ntfy app using the same topic name",
|
|
},
|
|
{
|
|
Service: "generic",
|
|
Name: "Generic JSON Webhook",
|
|
URLPattern: "",
|
|
Method: "POST",
|
|
Headers: map[string]string{"Content-Type": "application/json"},
|
|
PayloadTemplate: `{
|
|
"alert": {
|
|
"id": "{{.ID}}",
|
|
"level": "{{.Level}}",
|
|
"type": "{{.Type}}",
|
|
"resource_name": "{{.ResourceName}}",
|
|
"node": "{{.Node}}",
|
|
"message": "{{.Message}}",
|
|
"value": {{.Value}},
|
|
"threshold": {{.Threshold}},
|
|
"start_time": "{{.StartTime}}",
|
|
"duration": "{{.Duration}}"
|
|
},
|
|
"timestamp": "{{.Timestamp}}",
|
|
"source": "pulse-monitoring"
|
|
}`,
|
|
Instructions: "Configure with your custom webhook endpoint",
|
|
},
|
|
}
|
|
}
|