WebSignal Developer DocumentationBuild, monitor, and integrate with the WebSignal platform
Welcome
WebSignal is a website monitoring and uptime platform that keeps you informed about the health, performance, and availability of your web services. Get alerted instantly when something goes wrong, track performance trends over time, and let AI agents manage your incident workflows.
This documentation covers the WebSignal REST API and the MCP (Model Context Protocol) AI integration server. Whether you’re building a custom dashboard, integrating alerts into your workflow, or connecting an AI assistant, you’ll find everything you need here.
REST API Reference
49 endpoints across 8 resource groups — monitors, incidents, alerts, users, and more.
MCP / AI Integration
Connect AI assistants and copilots to your monitoring data via the Model Context Protocol.
Platform Features
Uptime Monitoring
HTTP availability checks with configurable intervals from 1 minute to 1 hour. Know instantly when your site goes down.
SSL Certificate Monitoring
Track certificate expiration dates and get notified before renewals are missed. Avoid unexpected security warnings.
Latency Tracking
Monitor response times with percentile analytics. Detect performance degradation before users notice.
DNS Monitoring
Watch for unexpected DNS changes, propagation issues, and resolution failures across record types.
Incident Management
Automatic incident detection with timeline tracking, notes, and acknowledgment workflows. Full history for postmortems.
Multi-Channel Alerts
Get notified via email, SMS, or webhooks. Configure multiple alert actions per monitor with flexible routing.
Performance Reports
Generate on-demand reports with availability percentages, latency trends, and incident summaries for any time range.
AI Agent Access (MCP)
Let AI assistants and copilots read monitoring data, manage incidents, and automate workflows via MCP tools.
Service Groups
Service Groups help you organize related checks for a single service or hostname. From an external API perspective, a monitor can belong to one Service Group at a time, and each Service Group can include up to four monitor capabilities: HTTP Availability, SSL Certificate, Latency, and DNS.
To reduce duplicate checks, each Service Group allows only one monitor per monitor type. For example, you can have one HTTP check and one DNS check in the same Service Group, but you cannot add two HTTP checks to that same group.
How to work with Service Groups
- Create your first monitor for a URL using
POST /api/v1/monitor. - Provide
serviceGroupIdwhen creating or updating monitors to attach them to a specific Service Group. - Use
GET /api/v1/service-groupto list group composition and monitor assignments. - Use
DELETE /api/v1/service-group/{id}to request soft-delete of the group and any non-shared monitors.
Plans & Pricing
WebSignal offers tiered plans to match your monitoring needs. All paid plans include a 14-day free trial.
- ✓ 50 monitors
- ✓ HTTP availability checks
- ✓ 5-minute check interval
- ✓ 1 email alert group
- ✗ SMS alerts
- ✗ Webhook alerts
- ✗ AI agent access
- ✓ 25 monitors
- ✓ HTTP, SSL & Latency checks
- ✓ 1-minute check interval
- ✓ 1 email alert group
- ✓ 1 SMS alert group
- ✗ Webhook alerts
- ✓ AI agent read access
- ✓ 100 monitors
- ✓ HTTP, SSL, Latency & DNS
- ✓ 1-minute check interval
- ✓ 2 email alert groups
- ✓ 2 SMS alert groups
- ✓ 2 webhook alert groups
- ✓ AI agent read + write
- ✓ Everything in Pro, plus:
- ✓ 200+ monitors (negotiable)
- ✓ Custom alert group limits
- ✓ Bespoke integrations
- ✓ Dedicated support
- ✓ Talk to Sales
Plan Comparison
| Feature | Starter | Growth | Pro | Enterprise |
|---|---|---|---|---|
| Monitors | 50 | 25 | 100 | 200+ (negotiable) |
| Check interval | 5 min | 1 min | 1 min | 1 min |
| Monitor types | HTTP | HTTP, SSL, Latency | HTTP, SSL, Latency, DNS | All Pro types + custom |
| Email alert groups | 1 | 1 | 2 | Custom |
| SMS alert groups | — | 1 | 2 | Custom |
| Webhook alert groups | — | — | 2 | Custom |
| AI agent (MCP) read | — | ✓ | ✓ | ✓ |
| AI agent (MCP) write | — | — | ✓ | ✓ |
API Overview
| Property | Value |
|---|---|
| Base URL | https://api.websignal.io |
| API version | v1 |
| Content type | application/json |
| OpenAPI spec | https://api.websignal.io/swagger/v1/swagger.json |
| Health check | https://api.websignal.io/health |
| MCP endpoint | https://api.websignal.io/mcp |
The platform exposes two complementary interfaces: a REST API for traditional HTTP integrations and an MCP server for AI agent interoperability. Both share the same authentication model and underlying data.
Authentication
All APIs use OAuth 2.0 Bearer tokens issued by Auth0. Include the token in the Authorization header:
Authorization: Bearer <access_token>Supported grant types:
- Authorization Code + PKCE — web and mobile applications
- Client Credentials — machine-to-machine integration
- Device Code — CLI and headless clients (including AI agents)
Most endpoints require the monitor.admin scope. See individual endpoint pages for specific scope requirements.
Getting Started
Choose the integration approach that fits your use case:
- REST API — View the full endpoint reference to build custom dashboards, automate monitor management, or integrate alerts into your existing tools.
- MCP / AI — Connect an AI assistant to query monitors, view incidents, and manage your monitoring setup through natural language.