Documentation

PulseMon uses a dead-man's-switch model. Your job pings us on success; if we don't hear from it in time, we alert you.

Alert escalation: When a monitor goes down you receive an immediate alert, then follow-up reminders at 1 h, 6 h, and 24 h. After that, reminders repeat daily until the monitor recovers.

By default, every ping is treated as a success and resets the monitor's deadline. If your job detects an error, you can report it explicitly with ?status=fail.

A fail ping is recorded in your ping history but does not mark the monitor as "up". It won't reset the deadline or resolve an open incident. Use this to tell apart "the job ran but errored" from "the job ran successfully."

#!/bin/bash
set -e

if /usr/local/bin/backup.sh; then
  curl -fsS --retry 3 "https://pulsemon.dev/api/ping/nightly-backup"
else
  curl -fsS --retry 3 "https://pulsemon.dev/api/ping/nightly-backup?status=fail"
fi

The ping endpoint enforces a rate limit of 1 request per second per slug. If you exceed this limit, the endpoint returns a 429 status code.

// 429 response
{ "ok": false, "error": "Rate limited" }

This prevents accidental flood loops. Any real cron job or heartbeat stays well under 1 req/sec. If you use curl --retry 3, retries will back off naturally and won't hit this limit.

If you configure a secret on your webhook alert channel, PulseMon signs every request with an HMAC-SHA256 signature in the X-PulseMon-Signature header. The format is sha256=<hex>. Verify this before processing the payload.

import crypto from "crypto";

function verifySignature(body, secret, signatureHeader) {
  const expected = "sha256=" +
    crypto.createHmac("sha256", secret).update(body).digest("hex");

  return crypto.timingSafeEqual(
    Buffer.from(expected),
    Buffer.from(signatureHeader),
  );
}

// In your webhook handler:
app.post("/webhooks/pulsemon", (req, res) => {
  const signature = req.headers["x-pulsemon-signature"];
  const body = JSON.stringify(req.body);

  if (!signature || !verifySignature(body, process.env.WEBHOOK_SECRET, signature)) {
    return res.status(401).json({ error: "Invalid signature" });
  }

  const event = req.body;
  console.log(`Monitor ${event.monitor.name} is ${event.event}`);
  res.json({ ok: true });
});

Create API keys in Settings → API Keys to manage monitors programmatically. Keys use Bearer token auth with the prefix pm_. You only see the raw key once at creation, so store it somewhere safe.

curl https://pulsemon.dev/api/v1/monitors \
  -H "Authorization: Bearer pm_your-api-key"

curl -X POST https://pulsemon.dev/api/v1/monitors \
  -H "Authorization: Bearer pm_your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Nightly Backup",
    "slug": "nightly-backup",
    "expectedInterval": 86400,
    "gracePeriod": 900
  }'

All endpoints return { "data": T, "error": null } on success and { "data": null, "error": { "code": "...", "message": "..." } } on failure. Missing or invalid keys return 401.

Use PulseMon from WhatsApp, Telegram, or Slack via OpenClaw. Install the skill and manage your monitors with natural language.

clawhub install pulsemon

Set your API key as an environment variable:

PULSEMON_API_KEY=pm_your-key-here

Then ask your agent things like "check my monitors", "create a monitor called nightly-backup that runs daily", or "pause the data-sync monitor".