Better Stack · Schema

IncidentCreateRequest

Request body for creating a manual incident.

IncidentsLogsMonitoringPlatformStatusUptimeObservabilityOn-CallHeartbeats

Properties

Name Type Description
name string Name or description of the incident.
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-incident-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-incident-create-request-schema.json",
  "title": "IncidentCreateRequest",
  "description": "Request body for creating a manual incident.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name or description of the incident.",
      "example": "Database degraded"
    },
    "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"
  ]
}