How to install and set up Watchman for Clientexec Print

  • hetrixtools, watchman, uptimerobot, install, clientexec, uptime
  • 0

Watchman turns your HetrixTools or UptimeRobot monitors into a Network Status page inside your Clientexec client portal. It's free for life, and setup takes about five minutes.

Before you start

  • Clientexec 7.3 or newer
  • PHP 8.3 or 8.4, with ionCube Loader 15 or newer
  • The Clientexec cron running
  • A HetrixTools or UptimeRobot account with at least one monitor (free plans work)
  • Your free Watchman license key, found in your K & K client area under Services

Step 1: Upload the files

  1. Download Watchman from your K & K client area. Pick the zip that matches your PHP version (8.3 or 8.4).
  2. Upload the zip to your Clientexec folder and extract it. You should now have plugins/snapin/watchman and plugins/services/watchmansync.

Step 2: Enable the snapin and the sync service

  1. In Clientexec admin, go to Settings > Plugins > Snapins and enable Watchman.
  2. Go to Settings > Plugins > Services, enable Watchman Sync and leave it set to run every 5 minutes.

Step 3: Create a HetrixTools API key

  1. Log in to HetrixTools and go to API & MCP > API Keys.
  2. Create a new key and limit its scope to read-only access for Uptime monitors and Blacklist monitors (shield icon).
  3. Copy the key.

Using UptimeRobot instead? Skip this step and see the UptimeRobot section below.

Step 4: Configure Watchman

  1. Go to Support > Watchman and open Settings.
  2. Enter your License Key and paste your HetrixTools API Key.
  3. Choose your options, then click Save Settings.

Step 5: Check your key and run the first sync

  1. Click Check API key. It tells you if the key can do more than Watchman needs.
  2. Click Sync now. Your monitors appear within a few seconds.

Network Status now appears in your client Support menu and as a tile on the portal home page. From here on, the Watchman Sync service keeps it up to date.

Using UptimeRobot instead of HetrixTools (1.1.0 and newer)

  1. In UptimeRobot, go to Integrations & API and copy your Read-only API key.
  2. In Support > Watchman > Settings, set Data Source to UptimeRobot and paste the key into UptimeRobot API Key. Click Save Settings.
  3. Click Check API key. It should say the key is read-only and how many monitors it found. Then click Sync now.

Good to know: clients see each monitor's UptimeRobot "Friendly Name". The Blacklist Center is a HetrixTools feature, so it's hidden with UptimeRobot. Switching the data source starts from a clean cache.

Optional settings

  • Hide monitors: untick any monitor in Support > Watchman and click Save visibility to hide it from clients.
  • Incident notes: add a note to any incident and clients see it on the status page.
  • Public page: turn it on to let visitors see the status page without logging in.

Updating

Download the new version, extract it over your existing install and replace the files, then open Support > Watchman to confirm it's running. Your settings, incident notes and hidden monitors are kept.

Troubleshooting

  • No monitors after Sync now: click Check API key and make sure the key has read access to your monitors.
  • Status never updates: check that the Watchman Sync service is enabled and the Clientexec cron is running.
  • Check API key says Main API key: use the UptimeRobot Read-only key instead. The Main key can change your UptimeRobot account.
  • License shows invalid: make sure the license key is entered exactly and that Clientexec is installed on the domain the license was issued for. You can reissue it from your K & K client area if you've moved Clientexec.

Need help? Open a support ticket. Full feature list: Watchman for Clientexec.


Was this answer helpful?

« Back