Datadog · Schema

IncidentCreateAttributes

Attributes for creating a new incident

AnalyticsDashboardsMonitoringPlatformT1Visualizations

Properties

Name	Type	Description
title	string	The title of the incident describing what is affected and the nature of the issue
customer_impacted	boolean	Whether the incident is causing direct customer impact (required field for all incidents)
customer_impact_scope	string	Description of the customer groups or features affected by this incident
customer_impact_start	string	ISO 8601 timestamp when customer impact started, if known
severity	string	The severity level of the incident using SEV-N notation
state	string	The initial state of the incident
fields	object	Custom fields for the incident as configured in your organization settings
notification_handles	array	List of user and team notification handles to page on incident creation

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/datadog/refs/heads/main/json-schema/datadog-incidents-incident-create-attributes-schema.json",
  "title": "IncidentCreateAttributes",
  "description": "Attributes for creating a new incident",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "The title of the incident describing what is affected and the nature of the issue",
      "example": "Example Monitor"
    },
    "customer_impacted": {
      "type": "boolean",
      "description": "Whether the incident is causing direct customer impact (required field for all incidents)",
      "example": true
    },
    "customer_impact_scope": {
      "type": "string",
      "description": "Description of the customer groups or features affected by this incident",
      "example": "example_value"
    },
    "customer_impact_start": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when customer impact started, if known",
      "example": "example_value"
    },
    "severity": {
      "type": "string",
      "description": "The severity level of the incident using SEV-N notation",
      "enum": [
        "SEV-1",
        "SEV-2",
        "SEV-3",
        "SEV-4",
        "SEV-5",
        "UNKNOWN"
      ],
      "example": "SEV-1"
    },
    "state": {
      "type": "string",
      "description": "The initial state of the incident",
      "enum": [
        "active",
        "stable",
        "resolved"
      ],
      "default": "active",
      "example": "active"
    },
    "fields": {
      "type": "object",
      "description": "Custom fields for the incident as configured in your organization settings",
      "additionalProperties": {
        "type": "object"
      }
    },
    "notification_handles": {
      "type": "array",
      "description": "List of user and team notification handles to page on incident creation",
      "items": {
        "type": "object",
        "properties": {
          "handle": {
            "type": "string",
            "description": "The Datadog handle or integration channel to notify"
          },
          "display_name": {
            "type": "string",
            "description": "The display name for this notification handle"
          }
        }
      }
    }
  },
  "required": [
    "title",
    "customer_impacted"
  ]
}