OpsGenie · Schema

CreateHeartbeatRequest

AlertsIncident ManagementMonitoringOn-Call

Properties

Name Type Description
name string Name of the heartbeat.
description string Description of what the heartbeat monitors.
interval integer Interval duration for the heartbeat ping.
intervalUnit string Unit for the heartbeat interval.
enabled boolean Whether the heartbeat is active.
ownerTeam object Team that owns the heartbeat.
alertMessage string Custom alert message when the heartbeat expires.
alertTags array Tags to add to the alert created by an expired heartbeat.
alertPriority string Priority of the alert created by an expired heartbeat.
View JSON Schema on GitHub

JSON Schema

opsgenie-createheartbeatrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateHeartbeatRequest",
  "title": "CreateHeartbeatRequest",
  "type": "object",
  "required": [
    "name",
    "interval",
    "intervalUnit",
    "enabled"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the heartbeat."
    },
    "description": {
      "type": "string",
      "description": "Description of what the heartbeat monitors."
    },
    "interval": {
      "type": "integer",
      "minimum": 1,
      "description": "Interval duration for the heartbeat ping."
    },
    "intervalUnit": {
      "type": "string",
      "enum": [
        "minutes",
        "hours",
        "days"
      ],
      "description": "Unit for the heartbeat interval."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the heartbeat is active."
    },
    "ownerTeam": {
      "type": "object",
      "description": "Team that owns the heartbeat.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Team ID."
        },
        "name": {
          "type": "string",
          "description": "Team name."
        }
      }
    },
    "alertMessage": {
      "type": "string",
      "description": "Custom alert message when the heartbeat expires."
    },
    "alertTags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Tags to add to the alert created by an expired heartbeat."
    },
    "alertPriority": {
      "type": "string",
      "enum": [
        "P1",
        "P2",
        "P3",
        "P4",
        "P5"
      ],
      "description": "Priority of the alert created by an expired heartbeat."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/opsgenie-createheartbeatrequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.