IncidentRead

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fettle-sh/json-schema/fettle-sh-incident-read-schema.json",
  "title": "IncidentRead",
  "description": "Response model for an open or resolved incident.",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/fettle-sh-api-openapi.json#/components/schemas/IncidentRead",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "title": "Id"
    },
    "monitor_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Monitor Id"
    },
    "heartbeat_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Heartbeat Id"
    },
    "started_at": {
      "type": "string",
      "format": "date-time",
      "title": "Started At"
    },
    "resolved_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Resolved At"
    },
    "cause": {
      "$ref": "#/$defs/IncidentCause"
    },
    "cause_detail": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cause Detail"
    },
    "last_notified_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Notified At"
    },
    "acknowledged_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Acknowledged At"
    },
    "acknowledged_by": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Acknowledged By"
    },
    "renotify_count": {
      "type": "integer",
      "title": "Renotify Count"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "Created At"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "title": "Updated At"
    },
    "notification_logs": {
      "items": {
        "$ref": "#/$defs/NotificationLogRead"
      },
      "type": "array",
      "title": "Notification Logs"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "id",
    "started_at",
    "resolved_at",
    "cause",
    "cause_detail",
    "last_notified_at",
    "acknowledged_at",
    "acknowledged_by",
    "renotify_count",
    "created_at",
    "updated_at"
  ],
  "$defs": {
    "ChannelType": {
      "type": "string",
      "enum": [
        "EMAIL",
        "TELEGRAM",
        "WEBHOOK",
        "SLACK",
        "DISCORD"
      ],
      "title": "ChannelType",
      "description": "Transport for a user notification channel."
    },
    "IncidentCause": {
      "type": "string",
      "enum": [
        "TIMEOUT",
        "DNS_FAILURE",
        "CONNECTION_REFUSED",
        "TLS_INVALID",
        "HTTP_4XX",
        "HTTP_5XX",
        "HTTP_UNEXPECTED_STATUS",
        "KEYWORD_MISSING",
        "TOO_MANY_REDIRECTS",
        "TARGET_BLOCKED",
        "PORT_STATE_MISMATCH",
        "INVALID_TARGET",
        "HEARTBEAT_MISSED",
        "HEARTBEAT_FAILED",
        "UNKNOWN"
      ],
      "title": "IncidentCause",
      "description": "Structured cause of an incident, across both incident sources.\n\nA superset of the worker's wire ``FailureKind``: every value the worker can\nreport is storable here, plus the causes only the core can observe (a\nheartbeat that never pinged, a client that reported its own failure). The\ntwo enums are declared separately so the worker contract does not grow\nvalues the worker never emits — ``test_enums.py`` guards the subset\nrelation, which is what keeps ``process_check_result`` able to store any\nincoming ``failure_kind``.\n\nThe raw human-readable reason lives in ``Incident.cause_detail``."
    },
    "NotificationEvent": {
      "type": "string",
      "enum": [
        "TRIGGERED",
        "RESOLVED",
        "SSL_EXPIRY"
      ],
      "title": "NotificationEvent",
      "description": "Lifecycle event that triggered an outgoing notification."
    },
    "NotificationLogRead": {
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "title": "Id"
        },
        "channel_type": {
          "$ref": "#/$defs/ChannelType"
        },
        "destination": {
          "type": "string",
          "title": "Destination"
        },
        "event": {
          "$ref": "#/$defs/NotificationEvent"
        },
        "sent_at": {
          "type": "string",
          "format": "date-time",
          "title": "Sent At"
        },
        "status": {
          "$ref": "#/$defs/NotificationStatus"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Error"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "id",
        "channel_type",
        "destination",
        "event",
        "sent_at",
        "status",
        "error"
      ],
      "title": "NotificationLogRead",
      "description": "One delivery attempt in an incident's notification timeline."
    },
    "NotificationStatus": {
      "type": "string",
      "enum": [
        "PENDING",
        "SENT",
        "FAILED"
      ],
      "title": "NotificationStatus",
      "description": "Delivery outcome for an outgoing notification."
    }
  }
}