Skip to content
Intally

Quick start

Quick start

Smart Alerting Hub is the central notification hub for your WHMCS install: route 26 invoice / ticket / order / service / client / network / admin events to Email, Slack, Telegram, Discord, WhatsApp, SMS, PagerDuty, or custom Webhooks — all from a single dashboard. This guide covers install, your first alert channel, and Pro features (templates / on-call / dedup / digests).

For WHMCS hosts and MSPs. Works on any WHMCS instance with zero business-logic impact.

1. Install and activate

  1. Download the ZIP matching your PHP version (e.g. smart_alerting_hub_v1.x.x_php8.1.zip) and extract into your WHMCS root.
  2. WHMCS admin → Setup → Apps & Integrations → Smart Alerting Hub → Activate.
  3. Configuration → Addon Modules → Smart Alerting Hub → tick admin roles allowed access (Full Administrator recommended) + paste your license key (Pro features only) + Save.
  4. Top menu Addons → Smart Alerting Hub opens the console.

Activation creates 6 tables (settings / channels / rules / templates / oncall / alerts) and registers hooks listening on 26 WHMCS event types.

2. Dashboard

The dashboard shows:

  • Today's alert counters (total / sent / failed)
  • Active channel list with health status
  • 10 most recent alerts
  • License tier and feature matrix (free vs Pro)
  • Check-for-updates panel

Top tabs switch to Channels / Templates / On-Call / History / Settings.

3. Configure your first channel

Channels page → "New channel":

  1. Pick type: Email / Slack / Telegram / Discord / WhatsApp / SMS / PagerDuty / custom Webhook.
  2. Fill the type-specific config: - Email: recipient addresses (comma separated) - Slack: incoming webhook URL - Telegram: bot token + chat ID - PagerDuty: integration key - Custom Webhook: URL + optional HTTP headers
  3. Pick which of the 26 event types to subscribe.
  4. Save, then click "Test" to verify connectivity.

Free tier allows Email + 1 extra channel (Slack or Telegram); Pro unlocks all 8 types.

4. Message templates (Pro)

The Templates page customises alert message format:

  • Default templates ship per event type (works out of the box)
  • Per-channel override: the same event can be a structured Slack card, full-HTML email, etc.
  • Per-event override: "invoice overdue" and "service expired" can use different wording

Templates support variable interpolation (e.g. {client_name} / {invoice_id} / {amount}); changes take effect on the next alert.

5. On-call rotation (Pro)

The On-Call page:

  1. New schedule → pick the channel(s) and event types in scope, plus the responder roster.
  2. Set weekly recurrence (Mon 09:00 → Wed 18:00 = Alice / Thu 09:00 → Sun 18:00 = Bob).
  3. Enable — alerts during a slot route to that responder's channel automatically.

6. History and retry

The History page lists every alert (7-day retention free, up to 90-day on Pro):

  • Filter by time / status / event type / channel
  • "Retry" button manually re-sends failed alerts
  • CSV export for audit

7. Settings (Pro)

The Settings page:

  • Dedup cooldown: only one alert for the same event within X minutes (silence noise)
  • Mute window: pause all alerts during maintenance (e.g. Sunday 02:00-06:00)
  • Alert digest: batch hourly or daily for non-urgent events
  • History retention days: default 7, up to 90 on Pro

8. FAQ

Q: What's free vs Pro? A: Free: Email + 1 extra channel (Slack or Telegram), 26 events, 7-day history, 100 alerts/day cap. Everything else needs Pro.

Q: Which events are supported? A: Invoices (created / paid / overdue), tickets (opened / replied / closed), orders (submitted / accepted / rejected), services (provisioned / suspended / terminated), clients (added / login / fraud-flagged), network (monitor anomalies), admin (admin-login / config-changed) — 26 in total.

Q: What's the payload format for custom webhooks? A: JSON: {event_type, timestamp, client_id, data: {...}}; the data field shape varies by event type.

Q: Will the same alert fire twice? A: Pro dedup cooldown keys on (event_type + primary ID). Non-Pro users should dedup on the receiver side.

For deeper docs (event parameter reference, template variables, hook timing) see the "Full documentation" link on your store dashboard card.