Datadog · Schema

EventCreateAttributes

The attributes for a new event to be created

AnalyticsDashboardsMonitoringPlatformT1Visualizations

Properties

Name Type Description
title string The event title displayed in the Events Explorer (max 100 characters)
message string The event body text with additional details about the event (max 4000 characters)
timestamp integer Unix timestamp in seconds for when the event occurred; defaults to current time if not specified
priority string The event priority level for filtering and sorting in the Events Explorer
host string The hostname to associate with this event for infrastructure correlation
tags array List of tags to apply to the event in key:value format for filtering
alert_type string The alert type category for visual display in the Events Explorer
aggregation_key string An arbitrary string used to group related events into a rollup (max 100 characters)
source_type_name string The source technology or integration that generated this event (e.g., aws, chef, nagios)
View JSON Schema on GitHub

JSON Schema

datadog-events-event-create-attributes-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/datadog/refs/heads/main/json-schema/datadog-events-event-create-attributes-schema.json",
  "title": "EventCreateAttributes",
  "description": "The attributes for a new event to be created",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "The event title displayed in the Events Explorer (max 100 characters)",
      "maxLength": 100,
      "example": "Example Monitor"
    },
    "message": {
      "type": "string",
      "description": "The event body text with additional details about the event (max 4000 characters)",
      "maxLength": 4000,
      "example": "CPU usage is high on {{host.name}}"
    },
    "timestamp": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp in seconds for when the event occurred; defaults to current time if not specified",
      "example": 42
    },
    "priority": {
      "type": "string",
      "description": "The event priority level for filtering and sorting in the Events Explorer",
      "enum": [
        "normal",
        "low"
      ],
      "default": "normal",
      "example": "normal"
    },
    "host": {
      "type": "string",
      "description": "The hostname to associate with this event for infrastructure correlation",
      "example": "example_value"
    },
    "tags": {
      "type": "array",
      "description": "List of tags to apply to the event in key:value format for filtering",
      "items": {
        "type": "string"
      }
    },
    "alert_type": {
      "type": "string",
      "description": "The alert type category for visual display in the Events Explorer",
      "enum": [
        "error",
        "warning",
        "info",
        "success",
        "user_update",
        "recommendation",
        "snapshot"
      ],
      "default": "info",
      "example": "error"
    },
    "aggregation_key": {
      "type": "string",
      "description": "An arbitrary string used to group related events into a rollup (max 100 characters)",
      "maxLength": 100,
      "example": "example_value"
    },
    "source_type_name": {
      "type": "string",
      "description": "The source technology or integration that generated this event (e.g., aws, chef, nagios)",
      "example": "Example Monitor"
    }
  },
  "required": [
    "title"
  ]
}