Skip to main content
Overwatch is built around a small set of concepts that compose into a complete monitoring setup. Understanding how monitors, check results, statuses, alert channels, and organizations relate to each other will help you configure Overwatch effectively and interpret what you see in the dashboard and API responses. This page covers each concept in depth.

​
Monitors

A monitor is a recurring check that Overwatch runs against a target on a defined interval. Every monitor has a type, a configuration, and a current status. Monitors belong to an organization, and you can attach one or more alert channels to each monitor so that the right people are notified when its status changes.

​
Monitor types

Overwatch supports five monitor types:

​
Monitor configuration

Each monitor type accepts a config object with type-specific fields. Common fields include:
  • url (HTTP) — the endpoint to request.
  • host / port (TCP) — the hostname and port to connect to.
  • interval — how often to run the check, in seconds. The minimum value depends on your plan.
  • alertChannelIds — optional list of alert channel IDs to attach at creation time.
For SCHEDULED monitors, Overwatch sets the internal interval automatically and returns a checkinUrl in the creation response. Your job must call that URL to signal successful completion.

​
Check results

Each time a monitor runs, Overwatch records a check result. A check result captures:
  • Status — the outcome of this specific run (see status values below).
  • Latency — for HTTP and TCP checks, the round-trip time in milliseconds.
  • Detail — additional structured data depending on the check type (e.g., HTTP status code, certificate expiry date, DNS record value).
  • Alert outcome — whether an alert fired and how it was delivered.
Overwatch retains check results for 90 days on Starter and Pro plans, and up to 2 years on Enterprise.

​
Statuses

Every monitor has a current status that reflects the outcome of its most recent check. Status values differ by monitor type.

​
HTTP and TCP

​
TLS

​
DNS

​
Scheduled (heartbeat)

​
Organization-level status

Overwatch also computes an overall status for your entire organization, visible on the dashboard and in the /api/v1/status endpoint:

​
Alert channels

An alert channel is a delivery destination for notifications. Overwatch fires an alert on a monitor when that monitor’s status changes — for example, when an HTTP endpoint transitions from up to down, or when a certificate moves from active to expiring_soon. Alerts also fire on recovery.

​
Supported channel types

  • Slack — posts a formatted message to a Slack channel via the Overwatch Slack app.
  • Discord — delivers a notification to a Discord server channel via webhook.
  • Microsoft Teams — sends a message card to a Teams channel via webhook.
  • Email — sends a notification to one or more email addresses.
  • Webhook — sends a JSON POST to any URL, making it compatible with PagerDuty, custom scripts, and other tools.
PagerDuty and SMS are defined in the data model but are not yet available through the API or dashboard. Use a webhook to route alerts to PagerDuty in the meantime.
Each alert channel can be attached to multiple monitors. You can enable or disable a channel independently of the monitors it is bound to.

​
Organizations

All resources in Overwatch — monitors, alert channels, API keys, and team members — belong to an organization. When you sign up, Overwatch creates an organization for you automatically.

​
Multiple organizations

You can be a member of more than one organization. Use the organization switcher in the dashboard to move between them. Each organization has its own monitors, billing subscription, and member list.

​
Roles

Every organization membership has a role that controls what actions the member can perform: API keys also carry a role. A key with the viewer role can only read data; a key with the admin or owner role can create and modify resources.

​
API keys

An API key is a long-lived credential that authenticates requests to the Overwatch REST API on behalf of an organization. Keys are scoped to an organization and carry a role, just like a human member.

​
Key format

All API keys start with the prefix ow_live_sk_. You pass the key in the Authorization header of every API request:

​
Generating a key

Generate API keys in Settings → Security. The full key value is shown only once at creation — copy it immediately and store it securely. Overwatch stores only a hash of the key and cannot display it again. Keys can be given an expiration date. Overwatch rejects requests from expired keys with a 401 Unauthorized response.
Treat API keys like passwords. Do not commit them to version control or share them in public channels. If a key is compromised, delete it from Settings → Security and generate a new one.
For a full reference of available endpoints, request fields, and response shapes, see the API reference.