{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/datadog/refs/heads/main/json-schema/datadog-event-schema.json", "title": "Datadog Event", "description": "A Datadog event representing a notable change or activity within monitored infrastructure or applications. Events are displayed in the Datadog Events Explorer and can be overlaid on metric graphs for correlating infrastructure changes with performance impacts. Common event sources include code deployments, configuration changes, alert state transitions, auto-scaling actions, health check state changes, and custom business events submitted via the API. Events are retained for 180 days.", "type": "object", "properties": { "id": { "type": "string", "description": "The unique string identifier assigned by Datadog to this event. Used to retrieve a specific event via the API. Events submitted via the v1 API use numeric IDs, while v2 events use string identifiers." }, "type": { "type": "string", "description": "The resource type identifier for events (always 'event')", "enum": ["event"] }, "attributes": { "$ref": "#/$defs/EventAttributes" } }, "$defs": { "EventAttributes": { "type": "object", "description": "The core attributes of a Datadog event containing all displayable and filterable information about the event.", "properties": { "title": { "type": "string", "description": "The event title displayed prominently in the Events Explorer and event overlays on metric graphs. Should be concise and clearly describe what happened (e.g., 'Deployment: api-service v2.1.4 to production'). Maximum 100 characters.", "maxLength": 100 }, "text": { "type": "string", "description": "The event body text providing detailed information about the event. Supports Markdown formatting for rich text display in the Events Explorer. May include change descriptions, affected systems, related links, and runbook references. Maximum 4000 characters.", "maxLength": 4000 }, "message": { "type": "string", "description": "Alias for text in some API contexts, containing the event body content with optional Markdown formatting" }, "timestamp": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp indicating when the event occurred. For events submitted via the API, this can be set to a specific time using the date_happened field. Defaults to the time the event was received by Datadog." }, "date_happened": { "type": "integer", "format": "int64", "description": "Unix timestamp in seconds indicating when the event actually occurred. This can be set to a past time (up to 18 hours ago) or a future time (up to 5 minutes ahead) to accurately represent when the event took place.", "minimum": 0 }, "priority": { "type": "string", "description": "The priority level of the event controlling its visual prominence in the Events Explorer. Normal priority events appear as full entries while low priority events are collapsed by default.", "enum": ["normal", "low"], "default": "normal" }, "host": { "type": "string", "description": "The hostname to associate with this event for infrastructure correlation. When set, the event appears in the host's event stream and can be filtered by host in the Events Explorer." }, "tags": { "type": "array", "description": "List of tags to apply to the event in key:value format. Tags enable filtering events in the Events Explorer and correlating events with metrics and monitors by shared tags. Common tags include env, service, version, region, and team.", "items": { "type": "string", "description": "A tag in key:value format (e.g., env:production, service:api, version:2.1.4)" } }, "alert_type": { "type": "string", "description": "The visual alert type category that determines the event's icon and color in the Events Explorer. Use 'error' for failures and outages, 'warning' for degraded states, 'info' for informational changes, and 'success' for completed deployments or recoveries.", "enum": ["error", "warning", "info", "success", "user_update", "recommendation", "snapshot"], "default": "info" }, "aggregation_key": { "type": "string", "description": "An arbitrary string used to group related events into a single rollup entry in the Events Explorer. Events with the same aggregation_key and source_type_name are grouped together when more than 10 events share the same key within a rolling 24-hour window. Maximum 100 characters.", "maxLength": 100 }, "source_type_name": { "type": "string", "description": "The source technology or integration that generated this event. Used for filtering events by source in the Events Explorer and applying source-specific icons. Common values include aws, chef, docker, github, jenkins, nagios, and pagerduty.", "examples": ["aws", "chef", "docker", "github", "jenkins", "kubernetes", "nagios", "pagerduty", "puppet"] }, "status": { "type": "string", "description": "The current status of the event (active for new events, expired for events older than 180 days)", "enum": ["active", "expired"] }, "device_name": { "type": "string", "description": "The name of the network device or specific infrastructure component associated with this event" }, "related_event_id": { "type": "integer", "format": "int64", "description": "The ID of a related event, used to create a parent-child relationship between events in the Events Explorer" } } }, "EventCreatePayload": { "type": "object", "description": "The payload format for submitting a new event via the Datadog Events API. This format is used when calling the POST /api/v2/events endpoint.", "required": ["title"], "properties": { "title": { "type": "string", "description": "The event title to display in the Events Explorer. Should clearly and concisely describe what happened.", "maxLength": 100 }, "message": { "type": "string", "description": "The detailed body text of the event with optional Markdown formatting. Use this field to provide context, links, and details about the event.", "maxLength": 4000 }, "timestamp": { "type": "integer", "format": "int64", "description": "Unix timestamp in seconds for when the event occurred. Can be set to a past time (up to 18 hours ago) to accurately represent when the event happened rather than when it was submitted." }, "priority": { "type": "string", "description": "The visual priority of the event in the Events Explorer", "enum": ["normal", "low"], "default": "normal" }, "host": { "type": "string", "description": "The hostname to associate with the event for infrastructure correlation" }, "tags": { "type": "array", "description": "Tags to apply to the event for filtering and correlation", "items": { "type": "string" } }, "alert_type": { "type": "string", "description": "The alert type category determining the event icon and color in the Events Explorer", "enum": ["error", "warning", "info", "success", "user_update", "recommendation", "snapshot"], "default": "info" }, "aggregation_key": { "type": "string", "description": "Key for grouping related events into rollups in the Events Explorer", "maxLength": 100 }, "source_type_name": { "type": "string", "description": "The source technology or integration that generated this event" } } }, "EventSearchFilter": { "type": "object", "description": "Filter criteria for searching events in the Events Explorer. Used as part of the events search API request body.", "properties": { "query": { "type": "string", "description": "A Datadog events search query string for filtering events. Supports full-text search, tag filtering (e.g., env:production), source filtering (source:aws), and alert type filtering (status:error)." }, "from": { "type": "string", "description": "The start of the search time range as an ISO 8601 timestamp (e.g., 2024-01-01T00:00:00Z) or relative time expression (e.g., now-24h)" }, "to": { "type": "string", "description": "The end of the search time range as an ISO 8601 timestamp or relative time expression (e.g., now)" } } } } }