Webhook payload reference

OnlineOrNot POSTs JSON to your webhook URL when events occur on your uptime checks, heartbeats, or status pages.

API version

Current version: 2021-05-28

Field names and formats are stable within a version. New versions are announced before release.

Uptime check events

uptime.down

Fires when an uptime check fails.

{
  "event": "uptime.down",
  "trigger": "down",
  "name": "Some Page",
  "url": "https://example.com/health",
  "alert_priority": "HIGH"
}

uptime.up

Fires when an uptime check recovers.

{
  "event": "uptime.up",
  "trigger": "up",
  "name": "Some Page",
  "url": "https://example.com/health",
  "alert_priority": "HIGH"
}

Heartbeat events

heartbeat.down

Fires when a heartbeat stops after missing its expected ping.

{
  "event": "heartbeat.down",
  "trigger": "down",
  "id": "aB3dE5gH7jK9mN2pQ4rS6tV8",
  "name": "Nightly backup job",
  "url": "https://onlineornot.com/app/heartbeats/aB3dE5gH7jK9mN2pQ4rS6tV8"
}

heartbeat.up

Fires when a heartbeat resumes.

{
  "event": "heartbeat.up",
  "trigger": "up",
  "id": "aB3dE5gH7jK9mN2pQ4rS6tV8",
  "name": "Nightly backup job",
  "url": "https://onlineornot.com/app/heartbeats/aB3dE5gH7jK9mN2pQ4rS6tV8"
}

Status page incident events

status_page.incident.started

Fires when a new incident is created on a status page.

{
  "api_version": "2025-01-27",
  "type": "status_page.incident.started",
  "data": {
    "object": {
      "object": "status_page",
      "id": "1234567890",
      "name": "My Status Page",
      "subdomain": "my-status-page",
      "custom_domain": "https://status.example.com",
      "incident": {
        "id": "1234567890",
        "title": "API degraded performance",
        "impact": "DEGRADED_PERFORMANCE",
        "started_at": "2025-05-07T12:34:56Z",
        "url": "https://status.example.com/incidents/1234567890",
        "components": [
          {
            "id": "component-id",
            "name": "API",
            "status": "DEGRADED_PERFORMANCE"
          }
        ]
      }
    }
  }
}

status_page.incident.updated

Fires when an incident is updated.

{
  "api_version": "2025-01-27",
  "type": "status_page.incident.updated",
  "data": {
    "object": {
      "object": "status_page",
      "id": "1234567890",
      "name": "My Status Page",
      "subdomain": "my-status-page",
      "custom_domain": "https://status.example.com",
      "incident": {
        "id": "1234567890",
        "title": "API degraded performance",
        "impact": "DEGRADED_PERFORMANCE",
        "started_at": "2025-05-07T12:34:56Z",
        "url": "https://status.example.com/incidents/1234567890",
        "components": [
          {
            "id": "component-id",
            "name": "API",
            "status": "DEGRADED_PERFORMANCE"
          }
        ]
      }
    }
  }
}

status_page.incident.resolved

Fires when an incident is resolved.

{
  "api_version": "2025-01-27",
  "type": "status_page.incident.resolved",
  "data": {
    "object": {
      "object": "status_page",
      "id": "1234567890",
      "name": "My Status Page",
      "subdomain": "my-status-page",
      "custom_domain": "https://status.example.com",
      "incident": {
        "id": "1234567890",
        "title": "API degraded performance",
        "impact": "DEGRADED_PERFORMANCE",
        "started_at": "2025-05-07T12:34:56Z",
        "url": "https://status.example.com/incidents/1234567890",
        "components": [
          {
            "id": "component-id",
            "name": "API",
            "status": "OPERATIONAL"
          }
        ]
      }
    }
  }
}

Field reference

Uptime and heartbeat fields

Field	Type	Description
event	string	Event type (uptime.down, uptime.up, heartbeat.down, or heartbeat.up)
trigger	string	Status change (down or up)
id	string	Heartbeat ID (heartbeat events only)
name	string	Check or heartbeat name
url	string or null	Monitored URL or heartbeat dashboard URL
alert_priority	string	Alert priority for uptime checks (LOW or HIGH)

Status page incident fields

Field	Type	Description
api_version	string	Webhook API version
type	string	Event type
data.object.id	string	Status page ID
data.object.name	string	Status page name
data.object.subdomain	string	Status page subdomain
data.object.custom_domain	string or null	Custom domain (if configured)
data.object.incident.id	string	Incident ID
data.object.incident.title	string	Incident title
data.object.incident.impact	string or null	Impact (MAJOR_OUTAGE, PARTIAL_OUTAGE, DEGRADED_PERFORMANCE, NO_IMPACT, or MAINTENANCE)
data.object.incident.started_at	string	ISO 8601 timestamp
data.object.incident.url	string	Public incident URL
data.object.incident.components	array	Status page components and their current statuses