Better Stack · Schema

HeartbeatAttributes

Attributes of a heartbeat monitor.

IncidentsLogsMonitoringPlatformStatusUptimeObservabilityOn-CallHeartbeats

Properties

Name	Type	Description
name	string	Human-readable name for the heartbeat.
url	string	The URL to ping to signal the heartbeat.
period	integer	Expected period between heartbeat pings in seconds.
grace	integer	Grace period in seconds before alerting.
status	string	Current status of the heartbeat.
call	boolean	Alert via phone call.
sms	boolean	Alert via SMS.
email	boolean	Alert via email.
push	boolean	Alert via push notification.
created_at	string	When the heartbeat was created.
updated_at	string	When the heartbeat was last updated.
paused_at	string	When the heartbeat was paused.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/better-stack/refs/heads/main/json-schema/better-stack-heartbeat-attributes-schema.json",
  "title": "HeartbeatAttributes",
  "description": "Attributes of a heartbeat monitor.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Human-readable name for the heartbeat.",
      "example": "Daily Backup Job"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL to ping to signal the heartbeat.",
      "example": "https://uptime.betterstack.com/api/v1/heartbeat/abc123"
    },
    "period": {
      "type": "integer",
      "description": "Expected period between heartbeat pings in seconds.",
      "example": 86400
    },
    "grace": {
      "type": "integer",
      "description": "Grace period in seconds before alerting.",
      "example": 3600
    },
    "status": {
      "type": "string",
      "description": "Current status of the heartbeat.",
      "enum": [
        "paused",
        "pending",
        "up",
        "down"
      ],
      "example": "up"
    },
    "call": {
      "type": "boolean",
      "description": "Alert via phone call.",
      "example": false
    },
    "sms": {
      "type": "boolean",
      "description": "Alert via SMS.",
      "example": false
    },
    "email": {
      "type": "boolean",
      "description": "Alert via email.",
      "example": true
    },
    "push": {
      "type": "boolean",
      "description": "Alert via push notification.",
      "example": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the heartbeat was created.",
      "example": "2025-06-01T00:00:00Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the heartbeat was last updated.",
      "example": "2026-04-01T00:00:00Z"
    },
    "paused_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the heartbeat was paused.",
      "example": null
    }
  }
}