Dynatrace · Schema

EventIngestPayload

The payload for ingesting a custom event into Dynatrace. All events require at least an eventType and title. Custom events can target specific entities, include a time window, and carry additional metadata as key-value properties.

AI OperationsAnalyticsAPMApplication Performance MonitoringApplication SecurityAutomationCloud MonitoringDigital Experience ManagementIntelligenceObservability

Properties

Name	Type	Description
eventType	string	The type of the custom event. Determines how the event is categorized and whether it triggers alerts or problem detection.
timeout	integer	How long the event remains open, in minutes, if no endTime is specified. Range: 1 to 60 minutes. If not specified, the event closes after a short default duration.
entitySelector	string	The entity selector specifying which entities the event should be associated with. For example, type(SERVICE),tag(production). Required for most event types.
title	string	The title of the event. This is displayed in the Dynatrace UI and in problem notifications. Required.
startTime	integer	The start time of the event as a Unix timestamp in milliseconds. If not specified, defaults to the current time.
endTime	integer	The end time of the event as a Unix timestamp in milliseconds. If specified, creates a closed event covering the time range.
properties	object	Additional key-value metadata to attach to the event. Maximum of 30 key-value pairs. Keys and values must be strings.

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "description": "The payload for ingesting a custom event into Dynatrace. All events require at least an eventType and title. Custom events can target specific entities, include a time window, and carry additional metadata as key-value properties.",
  "properties": {
    "eventType": {
      "type": "string",
      "description": "The type of the custom event. Determines how the event is categorized and whether it triggers alerts or problem detection.",
      "example": "AVAILABILITY_EVENT",
      "enum": [
        "AVAILABILITY_EVENT",
        "CUSTOM_ALERT",
        "CUSTOM_ANNOTATION",
        "CUSTOM_CONFIGURATION",
        "CUSTOM_DEPLOYMENT",
        "ERROR_EVENT",
        "MARKED_FOR_TERMINATION",
        "PERFORMANCE_EVENT",
        "RESOURCE_CONTENTION_EVENT"
      ]
    },
    "timeout": {
      "type": "integer",
      "description": "How long the event remains open, in minutes, if no endTime is specified. Range: 1 to 60 minutes. If not specified, the event closes after a short default duration.",
      "example": 1718153645993
    },
    "entitySelector": {
      "type": "string",
      "description": "The entity selector specifying which entities the event should be associated with. For example, type(SERVICE),tag(production). Required for most event types.",
      "example": "type(SERVICE)"
    },
    "title": {
      "type": "string",
      "description": "The title of the event. This is displayed in the Dynatrace UI and in problem notifications. Required.",
      "example": "example-value"
    },
    "startTime": {
      "type": "integer",
      "description": "The start time of the event as a Unix timestamp in milliseconds. If not specified, defaults to the current time.",
      "format": "int64",
      "example": 1718153645993
    },
    "endTime": {
      "type": "integer",
      "description": "The end time of the event as a Unix timestamp in milliseconds. If specified, creates a closed event covering the time range.",
      "format": "int64",
      "example": 1718153645993
    },
    "properties": {
      "type": "object",
      "description": "Additional key-value metadata to attach to the event. Maximum of 30 key-value pairs. Keys and values must be strings.",
      "example": {}
    }
  },
  "required": [
    "eventType",
    "title"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EventIngestPayload"
}