Spike.sh · Schema

Spike.sh Incident

Schema for an incident in the Spike.sh incident management platform.

Incident ManagementOn-CallAlertingEscalation PoliciesStatus PagesMonitoringDevOpsSRE

Properties

Name Type Description
_id string Unique incident identifier
counterId string Human-readable incident counter ID
title string Incident title or description
status string Current lifecycle status of the incident
priority string Incident priority level (p1 = highest)
severity string Incident severity level (sev1 = highest)
metadata object Additional incident metadata from the triggering integration
escalation string ID of the escalation policy applied to this incident
integration string ID of the integration that triggered this incident
publicSharing boolean Whether this incident is publicly shareable
createdAt string Timestamp when the incident was created
updatedAt string Timestamp when the incident was last updated
View JSON Schema on GitHub

JSON Schema

spike-sh-incident-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/spike-sh/main/json-schema/spike-sh-incident-schema.json",
  "title": "Spike.sh Incident",
  "description": "Schema for an incident in the Spike.sh incident management platform.",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "Unique incident identifier"
    },
    "counterId": {
      "type": "string",
      "description": "Human-readable incident counter ID"
    },
    "title": {
      "type": "string",
      "description": "Incident title or description"
    },
    "status": {
      "type": "string",
      "enum": ["triggered", "acknowledged", "resolved"],
      "description": "Current lifecycle status of the incident"
    },
    "priority": {
      "type": "string",
      "enum": ["p1", "p2", "p3", "p4", "p5"],
      "description": "Incident priority level (p1 = highest)"
    },
    "severity": {
      "type": "string",
      "enum": ["sev1", "sev2", "sev3"],
      "description": "Incident severity level (sev1 = highest)"
    },
    "metadata": {
      "type": "object",
      "description": "Additional incident metadata from the triggering integration",
      "additionalProperties": true
    },
    "escalation": {
      "type": "string",
      "description": "ID of the escalation policy applied to this incident"
    },
    "integration": {
      "type": "string",
      "description": "ID of the integration that triggered this incident"
    },
    "publicSharing": {
      "type": "boolean",
      "description": "Whether this incident is publicly shareable"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the incident was created"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the incident was last updated"
    }
  },
  "required": ["_id", "title", "status"]
}