Better Stack · Schema

IncidentAttributes

Attributes of an incident.

IncidentsLogsMonitoringPlatformStatusUptimeObservabilityOn-CallHeartbeats

Properties

Name	Type	Description
name	string	Name or subject of the incident.
url	string	URL of the affected monitor.
http_method	string	HTTP method of the affected check.
cause	string	Root cause description of the incident.
started_at	string	When the incident started.
acknowledged_at	string	When the incident was acknowledged.
resolved_at	string	When the incident was resolved.
status	string	Current incident status.
team_name	string	Team that owns the incident.
regions	array	Regions where the incident was detected.

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-incident-attributes-schema.json",
  "title": "IncidentAttributes",
  "description": "Attributes of an incident.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name or subject of the incident.",
      "example": "Production API"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "description": "URL of the affected monitor.",
      "example": "https://example.com"
    },
    "http_method": {
      "type": "string",
      "nullable": true,
      "description": "HTTP method of the affected check.",
      "example": "GET"
    },
    "cause": {
      "type": "string",
      "nullable": true,
      "description": "Root cause description of the incident.",
      "example": "Connection timeout"
    },
    "started_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the incident started.",
      "example": "2026-04-18T14:00:00Z"
    },
    "acknowledged_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the incident was acknowledged.",
      "example": "2026-04-18T14:05:00Z"
    },
    "resolved_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the incident was resolved.",
      "example": "2026-04-18T14:15:00Z"
    },
    "status": {
      "type": "string",
      "description": "Current incident status.",
      "enum": [
        "Started",
        "Resolved"
      ],
      "example": "Resolved"
    },
    "team_name": {
      "type": "string",
      "description": "Team that owns the incident.",
      "example": "my-team"
    },
    "regions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Regions where the incident was detected.",
      "example": [
        "us"
      ]
    }
  }
}