Better Stack · Schema

HeartbeatCreateRequest

Request body for creating a heartbeat.

IncidentsLogsMonitoringPlatformStatusUptimeObservabilityOn-CallHeartbeats

Properties

Name Type Description
name string Name for the heartbeat.
period integer Expected period in seconds.
grace integer Grace period in seconds.
email boolean Alert via email.
sms boolean Alert via SMS.
call boolean Alert via phone call.
push boolean Alert via push notification.
View JSON Schema on GitHub

JSON Schema

better-stack-heartbeat-create-request-schema.json Raw ↑ 
{
  "$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-create-request-schema.json",
  "title": "HeartbeatCreateRequest",
  "description": "Request body for creating a heartbeat.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name for the heartbeat.",
      "example": "Daily Backup Job"
    },
    "period": {
      "type": "integer",
      "description": "Expected period in seconds.",
      "example": 86400
    },
    "grace": {
      "type": "integer",
      "description": "Grace period in seconds.",
      "example": 3600
    },
    "email": {
      "type": "boolean",
      "description": "Alert via email.",
      "example": true
    },
    "sms": {
      "type": "boolean",
      "description": "Alert via SMS.",
      "example": false
    },
    "call": {
      "type": "boolean",
      "description": "Alert via phone call.",
      "example": false
    },
    "push": {
      "type": "boolean",
      "description": "Alert via push notification.",
      "example": true
    }
  },
  "required": [
    "name",
    "period"
  ]
}