Dynatrace · JSON Structure

Events Api V2 Event Ingest Payload Structure

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.

Type: object Properties: 7 Required: 2

AI OperationsAnalyticsAPMApplication Performance MonitoringApplication SecurityAutomationCloud MonitoringDigital Experience ManagementIntelligenceObservability

EventIngestPayload is a JSON Structure definition published by Dynatrace, describing 7 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

eventType timeout entitySelector title startTime endTime properties

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/dynatrace/refs/heads/main/json-structure/events-api-v2-event-ingest-payload-structure.json",
  "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.",
  "type": "object",
  "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.",
      "enum": [
        "AVAILABILITY_EVENT",
        "CUSTOM_ALERT",
        "CUSTOM_ANNOTATION",
        "CUSTOM_CONFIGURATION",
        "CUSTOM_DEPLOYMENT",
        "ERROR_EVENT",
        "MARKED_FOR_TERMINATION",
        "PERFORMANCE_EVENT",
        "RESOURCE_CONTENTION_EVENT"
      ],
      "example": "AVAILABILITY_EVENT"
    },
    "timeout": {
      "type": "int32",
      "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.",
      "minimum": 1,
      "maximum": 60,
      "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": "int64",
      "description": "The start time of the event as a Unix timestamp in milliseconds. If not specified, defaults to the current time.",
      "example": 1718153645993
    },
    "endTime": {
      "type": "int64",
      "description": "The end time of the event as a Unix timestamp in milliseconds. If specified, creates a closed event covering the time range.",
      "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.",
      "additionalProperties": {
        "type": "string"
      },
      "maxProperties": 30,
      "example": {}
    }
  },
  "required": [
    "eventType",
    "title"
  ],
  "name": "EventIngestPayload"
}