Files
Microsoft-Rewards-Script/docs/conclusionwebhook.md
Light a9e5693b71 V2.4.0 complete (#395)
* V2.4.0 (#381)

* Updated README.md to reflect version 2.1 and improve the presentation of Microsoft Rewards Automation features.

* Updated version to 2.1.5 in README.md and package.json, added new license and legal notice sections, and improved the configuration script for a better user experience.

* Mise à jour des messages de journalisation et ajout de vérifications pour le chargement des quiz et la présence des options avant de procéder. Suppression de fichiers de configuration obsolètes.

* Added serial protection dialog management for message forwarding, including closing by button or escape.

* feat: Implement BanPredictor for predicting ban risks based on historical data and real-time events

feat: Add ConfigValidator to validate configuration files and catch common issues

feat: Create QueryDiversityEngine to fetch diverse search queries from multiple sources

feat: Develop RiskManager to monitor account activity and assess risk levels dynamically

* Refactor code for consistency and readability; unify string quotes, improve logging with contextual emojis, enhance configuration validation, and streamline risk management logic.

* feat: Refactor BrowserUtil and Login classes for improved button handling and selector management; implement unified selector system and enhance activity processing logic in Workers class.

* feat: Improve logging with ASCII context icons for better compatibility with Windows PowerShell

* feat: Add sample account setup

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* feat: Update Node.js engine requirement to >=20.0.0 and improve webhook avatar handling and big fix Schedule

* Update README.md

* feat: Improve logging for Google Trends search queries and adjust fallback condition

* feat: Update version to 2.2.1 and enhance dashboard data retrieval with improved error handling

* feat: Update version to 2.2.2 and add terms update dialog dismissal functionality

* feat: Update version to 2.2.2 and require Node.js engine >=20.0.0

* feat: Ajouter un fichier de configuration complet pour la gestion des tâches et des performances

* feat: Mettre à jour la version à 2.2.3, modifier le fuseau horaire par défaut et activer les rapports d'analyse

* feat: update doc

* feat: update doc

* Refactor documentation for proxy setup, security guide, and auto-update system

- Updated proxy documentation to streamline content and improve clarity.
- Revised security guide to emphasize best practices and incident response.
- Simplified auto-update documentation, enhancing user understanding of the update process.
- Removed redundant sections and improved formatting for better readability.

* feat: update version to 2.2.7 in package.json

* feat: update version to 2.2.7 in README.md

* feat: improve quiz data retrieval with alternative variables and debug logs

* feat: refactor timeout and selector constants for improved maintainability

* feat: update version to 2.2.8 in package.json and add retry limits in constants

* feat: enhance webhook logging with username, avatar, and color-coded messages

* feat: update .gitignore to include diagnostic folder and bump version to 2.2.8 in package-lock.json

* feat: updated version to 2.3.0 and added new constants to improve the handling of delays and colors in logs

* feat: refactor ConclusionWebhook to improve structure and enhance message formatting

* feat: update setup scripts and version to 2.3.3, refactor paths for improved structure

* feat: refactor setup scripts to run via npm and improve error handling for package.json

* feat: refactor webhook avatar handling to use centralized constant from constants.ts

* feat: mettre à jour la version à 2.3.7 et améliorer le script de mise à jour avec des options de contrôle d'auto-mise à jour

* feat: activer la mise à jour automatique pour la configuration et les comptes

* feat: mettre à jour la version à 2.3.7 et améliorer la gestion des erreurs dans plusieurs fichiers

* feat: améliorer la gestion des erreurs et des délais dans plusieurs fichiers, y compris Axios et ConclusionWebhook

* feat: mettre à jour la version à 2.4.0 et améliorer la documentation sur le contrôle de mise à jour automatique

* feat: increase the number of passes per execution to 3 to improve task capture

* feat: update account management with new file format and filter disabled accounts

* feat: update version to 2.4.0, add reinstallation warning and support .jsonc extensions for configuration files

* fix: fix formatting of reinstallation message in README

* feat: add an important update notice in the README to recommend a complete reinstallation

* fix: remove backup instructions from installation guide in README

* fix: update notice in README for configuration file changes and fresh installation instructions

* fix: fix typographical error in README update notice

* Fix: Update avatar URL in Discord config and remove optional webhook properties

* exploit: add customization options for webhooks and improve notification format

* Fix build
2025-10-23 16:35:32 +02:00

5.2 KiB
Raw Blame History

📊 Discord Webhooks

Get beautiful run summaries in Discord


💡 What Is It?

Sends a professional, rich embed to your Discord server after each run with:

  • 📊 Total accounts processed with success/warning/banned breakdown
  • 💎 Points earned — clear before/after comparison
  • Performance metrics — average points and execution time
  • 📈 Per-account breakdown — detailed stats for each account
  • 🎨 Beautiful formatting — color-coded status, emojis, and clean layout
  • ⏱️ Timestamp and version info in footer

Quick Start

1. Create Webhook in Discord

  1. Open Discord → Right-click channel
  2. Edit ChannelIntegrations tab
  3. Create Webhook
  4. Copy webhook URL

2. Configure Script

Edit src/config.jsonc:

{
  "notifications": {
    "conclusionWebhook": {
      "enabled": true,
      "url": "https://discord.com/api/webhooks/123456789/abcdef-your-webhook-token",
      // Optional: Customize webhook appearance
      "username": "Microsoft Rewards",
      "avatarUrl": "https://media.discordapp.net/attachments/1421163952972369931/1421929950377939125/Gc.png"
    }
  }
}

That's it! You'll get a summary after each run.


📋 Example Summary

The new webhook format provides a clean, professional Discord embed with:

Main Summary Card

🎯 Microsoft Rewards — Daily Summary

Status: ✅ Success
Version: v2.4.0 • Run ID: abc123xyz
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

📊 Global Statistics
💎 Total Points Earned
15,230 → 16,890 (+1,660)

📊 Accounts Processed
✅ Success: 3 | ⚠️ Errors: 0 | 🚫 Banned: 0
Total: 3 accounts

⚡ Performance
Average: 553pts/account in 8m 32s
Total Runtime: 25m 36s

Per-Account Details

<EFBFBD> Account Details

✅ user1@example.com
└ Points: +720 (🖥️ 450 • 📱 270)
└ Duration: 7m 23s

✅ user2@example.com
└ Points: +940 (🖥️ 540 • 📱 400)
└ Duration: 9m 41s

✅ user3@example.com
└ Points: +0 (🖥️ 0 • 📱 0)
└ Duration: 8m 32s

Color coding:

  • 🟢 Green — All accounts successful
  • 🟠 Orange — Some accounts with errors
  • 🔴 Red — Banned accounts detected

🎯 Advanced: Separate Channels

Use different webhooks for different notifications:

{
  "notifications": {
    "webhook": {
      "enabled": true,
      "url": "https://discord.com/api/webhooks/.../errors-channel",
      "username": "Rewards Errors",
      "avatarUrl": "https://example.com/error-icon.png"
    },
    "conclusionWebhook": {
      "enabled": true,
      "url": "https://discord.com/api/webhooks/.../summary-channel",
      "username": "Rewards Summary",
      "avatarUrl": "https://example.com/success-icon.png"
    }
  }
}
  • webhook — Real-time errors during execution
  • conclusionWebhook — End-of-run summary

🎨 Customize Webhook Appearance

You can personalize how your webhook appears in Discord:

  • username — The display name shown in Discord (default: "Microsoft Rewards")
  • avatarUrl — Direct URL to an image for the webhook's avatar

Example:

"conclusionWebhook": {
  "enabled": true,
  "url": "YOUR_WEBHOOK_URL",
  "username": "My Custom Bot Name",
  "avatarUrl": "https://i.imgur.com/YourImage.png"
}

💡 Tip: If you set custom values for both webhook and conclusionWebhook, the conclusion webhook will use its own settings. Otherwise, it falls back to the main webhook settings.


🎨 New Enhanced Format Features

The v2.4+ webhook format includes:

Visual Improvements

  • Clean, professional layout with clear sections
  • 🎨 Color-coded status (Green/Orange/Red based on results)
  • 📊 Thumbnail image for brand recognition
  • Footer with timestamp and version info
  • 🔢 Formatted numbers with thousands separators

Better Organization

  • Main embed — Global statistics and summary
  • Detail fields — Per-account breakdown (auto-splits for many accounts)
  • Smart truncation — Long emails and errors are shortened intelligently
  • Status icons Success, ⚠️ Warning, 🚫 Banned

More Information

  • Before/After points — Clear progression tracking
  • Desktop vs Mobile breakdown per account
  • Success rate — Quick glance at account health
  • Performance metrics — Average time and points per account

Smart Splitting

If you have many accounts (5+), the webhook automatically splits details into multiple fields to avoid hitting Discord's character limits.


🛠️ Troubleshooting

Problem Solution
No message received Check webhook URL is complete
"Invalid webhook" Regenerate webhook in Discord
Partial data Ensure script completed fully

Test Webhook Manually

curl -X POST -H "Content-Type: application/json" -d '{"content":"Test message"}' "YOUR_WEBHOOK_URL"

📚 Next Steps

Want mobile alerts?
NTFY Push Notifications

Need detailed logs?
Diagnostics Guide


← Back to Hub | Config Guide