Quickstart Guide - 5 Minute Setup
Real-time monitoring for zero downtime
Intro
Deploy StatusPulse in Under 5 Minutes
Skip the boilerplate. StatusPulse ships with a hardened REST API, a lightweight CLI, and native webhook routing so your engineering team can track uptime, latency, and error rates from day one.
Our infrastructure spans 14 global probe locations (Ashburn, Frankfurt, Tokyo, Sydney, and more) with 10-second check intervals and sub-50ms alert propagation. This guide walks you through credential generation, CLI initialization, and webhook routing using concrete examples you can copy directly into your CI/CD pipeline.
API Key
Generate Your API Credentials
Navigate to /account/keys in the StatusPulse dashboard and click Create Production Key. Your key follows the sp_live_ prefix and defaults to monitor:read and alert:write scopes. Store it in your environment variables—never commit it to version control.
Authentication Header
Attach your key to every request using the standard Authorization: Bearer sp_live_9x2k... header. Rate limits are set to 1,200 requests per minute per key, with automatic backoff on 429 responses.
Scope Management
Restrict keys to specific services using the resource_prefix parameter. Example: sp_live_abc123&prefix=prod-api-gateway ensures the key can only provision monitors for services matching that exact path.
CLI Setup
Install & Configure the CLI
The StatusPulse CLI (sp) handles monitor provisioning, health-check scheduling, and incident lifecycle management directly from your terminal.
Run npm i -g @statuspulse/cli or brew tap statuspulse/tap && brew install statuspulse-cli. After installation, execute sp init to generate ~/.config/statuspulse/config.yaml. The wizard prompts for your API key, default region (us-east-1), and alert routing preference. Verify connectivity with sp ping --endpoint https://api.statuspulse.io/v1/status.
Once configured, provision a synthetic monitor in one command: sp monitor create --name checkout-service --url https://checkout.acme.io/health --interval 10s --method GET. The CLI returns a JSON manifest with the monitor ID, assigned probe nodes, and estimated first-check timestamp.
Webhook Config
Route Alerts to Your Stack
StatusPulse pushes incident payloads to your designated endpoints using HTTPS POST with automatic retry logic (exponential backoff up to 60 minutes). Every payload includes a X-StatusPulse-Signature header signed via HMAC-SHA256 using your webhook secret.
Payload Structure
Each event contains incident_id, severity (critical/warning/info), service_name, last_healthy_timestamp, and probe_location. Example: {"incident_id": "inc_7f4a2b", "severity": "critical", "service_name": "payment-processor", "status": "down"}.
Verification & Routing
Validate signatures server-side before processing. Route critical alerts to PagerDuty via sp webhook add --url https://events.pagerduty.com/v2/enqueue --secret pd_wh_883a, or pipe informational events to Slack using our native /api/v1/integrations/slack endpoint. All routes support TLS 1.2+ and custom headers.