Skip to content
NoSqlStudio
Documentation

Alerting Webhooks

Fan out alerts to Slack, Discord, Teams, PagerDuty or any generic webhook. Auto-triggers tied to slow queries, mongostat thresholds, change watchers, DataMask completions, and license events.

What it is

A workspace tab where you register outbound webhooks and rules. Each webhook has a destination URL, a body template (Slack / Discord / Teams / generic), and an optional secret header. Rules tie a triggering pattern to one or more webhooks — when a monitored signal crosses a threshold the engine fires the webhook with a JSON payload.

When to use

Wire your DBA team chat to NoSqlStudio so a slow-query spike pings #db-oncall the moment it happens, a DataMask job completion posts a green tick to #compliance, or a license expiry fires a PagerDuty incident 7 days before the deadline.

How to open

  1. In the NoSqlStudio desktop app, open the Tools menu → Alerting, or press Ctrl+Alt+Shift+A.
  2. A workspace tab opens with two tabs at the top: Webhooks (list + CRUD) and Rules (pattern + threshold + webhook picker).
  3. Click New Webhook, fill name + destination URL + body template + optional headers + scope. Click Test fire to confirm reachability.

Building a rule

  1. Open the Rules tab. Click New Rule. Pick a triggering pattern from the dropdown — slow query (p99 above threshold), mongostat metric crossed, change watcher fired, DataMask completed, DB Copy finished, license event, or any combination.
  2. Set the threshold (for numeric triggers) and the cooldown (so a noisy signal does not flood the channel).
  3. Pick which webhooks to fire. You can fan out to multiple destinations from one rule.
  4. Click Simulate. The engine fires a synthetic event and dispatches the webhook so you can verify formatting and routing without waiting for the real condition.

Auto-triggers wired today

These signals are already plumbed into the rule engine — no extra glue needed:

  • Slow query (Profiler) — p99 above the configured threshold over a moving window.
  • mongostat — server-level metric crossings (e.g. opcounters spike, lock queue length, page faults).
  • Change Watcher — any event matching a filter you defined.
  • DataMask job — start / finish / abort with outcome and policy.
  • DB Copy / DB Sync — completion with row counts and duration.
  • License — activation / deactivation / expiry approaching.
  • Audit log — anomalous line patterns (e.g. repeated failures).

Limitations (v1)

  • Webhooks are fired from the desktop main process — they only work while the NoSqlStudio app is running on the DBA workstation. For server-side alerting use the REST API + your existing scheduler instead.
  • No built-in retry on webhook failure beyond the 10s AbortController timeout. Use generic webhook + your own retry sidecar if you need delivery guarantees.
  • Persisted in userData/Alerting/webhooks.json — back up like any other config; not synced across machines automatically.