Events API - POST an event

Pushes custom events from third-party integrations to one or more monitored entities.

This endpoint enables third-party systems such as CI platforms (Jenkins, Bamboo, Electric Cloud, etc.) to provide additional details for Dynatrace automated root cause analysis.

You can use this endpoint to:

  • Push information-only events from third-party systems to provide additional information for Dynatrace automated root cause analysis. The time of event closure is already known and the event IDs are returned instantly. You can push these events for up to 30 days into the past. The information-only event types are:
    • CUSTOM_ANNOTATION
    • CUSTOM_CONFIGURATION
    • CUSTOM_DEPLOYMENT
    • CUSTOM_INFO
  • Push problem-opening events (for example, an error rate increase) to trigger the Dynatrace automated root cause analysis engine. Correlation IDs are returned instead of event IDs. These events stay open until the specified timeout expires. To prevent expiration, you can refresh these events by sending the same payload again. You can push these events for up to 60 minutes into the past. The problem-opening event types (sorted by highest to lowest severity) are:
    • AVAILABILITY_EVENT
    • ERROR_EVENT
    • PERFORMANCE_EVENT
    • RESOURCE_CONTENTION

The request consumes and produces an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/events
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/events

Parameters

The set of parameters depends on the event type. See Parameters mapping below for details.

Parameter Type Description In Required
body EventPushMessage

The JSON body of the request, containing parameters of the event.

body optional

The EventPushMessage object

Element Type Description Required
eventType string

The type of event.

The eventType element can hold these values.
required
start integer

The start timestamp of the event, in UTC milliseconds.

If not set, the current timestamp is used.

You can report information-only events up to 30 days into the past.

You can report problem-opening events up to 60 minutes into the past.

optional
end integer

The end timestamp of the event, in UTC milliseconds.

If not set, the current time is used for information-only events.

Not applicable to problem-opening events. Such an event stays open until it times out depending on the timeoutMinutes parameter.

optional
timeoutMinutes integer

The timeout for problem-opening events in minutes. Not applicable to information-only events.

If not set, 15 minutes is used. The maximum allowed value is 120 minutes.

You can refresh the event by sending the same payload again.

optional
attachRules PushEventAttachRules

The set of rules defining Dynatrace entities to be associated with the event.

You can specify tags to dynamically match Dynatrace entities or IDs of specific entities.

At least one entity ID or tag is required.

required
customProperties object

The set of any properties related to the event, in the "key" : "value" format.

optional
source string

The name or ID of the external source of the event.

required
annotationType string

The type of the custom annotation, for example DNS route has been changed.

optional
annotationDescription string

A detailed description of the custom annotation, for example DNS route has been changed to x.mydomain.com.

optional
description string

The textual description of the configuration change.

optional
deploymentName string

The ID of the triggered deployment.

optional
deploymentVersion string

The version of the triggered deployment.

optional
timeseriesIds string[]

A list of timeseries IDs, related to the event.

optional
deploymentProject string

The project name of the deployed package.

optional
ciBackLink string

The link to the deployed artifact within the 3rd party system.

optional
remediationAction string

The link to the deployment related remediation action within the external tool.

optional
original string

The previous value of the configuration.

optional
changed string

The new value of the configuration that has been set by the event.

optional
configuration string

The ID or the name of the configuration that has been changed by the event.

optional
title string

The title of the configuration that has been set by the event.

optional

The PushEventAttachRules object

The set of rules defining Dynatrace entities to be associated with the event.

You can specify tags to dynamically match Dynatrace entities or IDs of specific entities.

At least one entity ID or tag is required.

Element Type Description Required
entityIds string[]

The list of entity IDs to which the event should be attached.

optional
tagRule TagMatchRule[]

An object defining a matching rule to dynamically pick up entities.

optional

The TagMatchRule object

The list of tags to be used for matching Dynatrace entities.

Element Type Description Required
meTypes string[]

The list of types of the Dynatrace entities, for example hosts or services, you want to pick up by matching.

required
tags TagInfo[]

The list of tags you want to use for matching. At least one tag is required.

You can use custom tags from the UI, AWS tags, Cloud Foundry tags, OpenShift/Kubernetes, and tags based on environment variables.

required

The TagInfo object

Tag of a Dynatrace entity.

Element Type Description Required
context string

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

The context element can hold these values.
required
key string

The key of the tag.

Custom tags have the tag value here.

required
value string

The value of the tag.

Not applicable to custom tags.

optional

Possible values

Possible values for the context element in the TagInfo object:

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES

Possible values for the items element in the TagMatchRule object:

  • APPLICATION
  • APPLICATION_METHOD
  • APPLICATION_METHOD_GROUP
  • AUXILIARY_SYNTHETIC_TEST
  • AWS_APPLICATION_LOAD_BALANCER
  • AWS_AVAILABILITY_ZONE
  • AWS_LAMBDA_FUNCTION
  • AWS_NETWORK_LOAD_BALANCER
  • AZURE_API_MANAGEMENT_SERVICE
  • AZURE_APPLICATION_GATEWAY
  • AZURE_COSMOS_DB
  • AZURE_EVENT_HUB_NAMESPACE
  • AZURE_IOT_HUB
  • AZURE_LOAD_BALANCER
  • AZURE_REDIS_CACHE
  • AZURE_REGION
  • AZURE_SERVICE_BUS_NAMESPACE
  • AZURE_SQL_SERVER
  • AZURE_STORAGE_ACCOUNT
  • AZURE_VM
  • CF_APPLICATION
  • CF_FOUNDATION
  • CINDER_VOLUME
  • CUSTOM_APPLICATION
  • CUSTOM_DEVICE
  • CUSTOM_DEVICE_GROUP
  • DCRUM_APPLICATION
  • DCRUM_SERVICE
  • DCRUM_SERVICE_INSTANCE
  • DISK
  • DOCKER_CONTAINER_GROUP_INSTANCE
  • DYNAMO_DB_TABLE
  • EBS_VOLUME
  • EC2_INSTANCE
  • ELASTIC_LOAD_BALANCER
  • ENVIRONMENT
  • GCP_ZONE
  • GEOLOCATION
  • GEOLOC_SITE
  • GOOGLE_COMPUTE_ENGINE
  • HOST
  • HOST_GROUP
  • HTTP_CHECK
  • HTTP_CHECK_STEP
  • HYPERVISOR
  • KUBERNETES_CLUSTER
  • KUBERNETES_NODE
  • MOBILE_APPLICATION
  • NETWORK_INTERFACE
  • NEUTRON_SUBNET
  • OPENSTACK_PROJECT
  • OPENSTACK_REGION
  • OPENSTACK_VM
  • OS
  • PROCESS_GROUP
  • PROCESS_GROUP_INSTANCE
  • RELATIONAL_DATABASE_SERVICE
  • SERVICE
  • SERVICE_INSTANCE
  • SERVICE_METHOD
  • SERVICE_METHOD_GROUP
  • SWIFT_CONTAINER
  • SYNTHETIC_LOCATION
  • SYNTHETIC_TEST
  • SYNTHETIC_TEST_STEP
  • VIRTUALMACHINE
  • VMWARE_DATACENTER

Possible values for the eventType element in the EventPushMessage object:

  • AVAILABILITY_EVENT
  • CUSTOM_ANNOTATION
  • CUSTOM_CONFIGURATION
  • CUSTOM_DEPLOYMENT
  • CUSTOM_INFO
  • ERROR_EVENT
  • PERFORMANCE_EVENT
  • RESOURCE_CONTENTION

Parameters mapping

Availability event Custom annotation Custom configuration Custom deployment Custom info Error event Performance event Resource contention
description required optional required n/a required required required required
title required n/a n/a n/a optional required required required
source required required required required required required required required
annotationType n/a required n/a n/a n/a n/a n/a n/a
annotationDescription n/a required n/a n/a n/a n/a n/a n/a
deploymentName n/a n/a n/a required n/a n/a n/a n/a
deploymentVersion n/a n/a n/a required n/a n/a n/a n/a
deploymentProject n/a n/a n/a optional n/a n/a n/a n/a
ciBackLink n/a n/a n/a optional n/a n/a n/a n/a
remediationAction n/a n/a n/a optional n/a n/a n/a n/a
original n/a n/a optional n/a n/a n/a n/a n/a
configuration n/a n/a required n/a n/a n/a n/a n/a

Response format

The EventStoreResult object

Contains IDs of all custom events, created by an event push call.

Element Type Description
storedEventIds integer[]

List of event IDs for information-only-events.

This field is provided for compatibility reasons. You should use the values from the storedIds field instead.

storedIds string[]

List of encoded event IDs for information-only-events.

storedCorrelationIds string[]

List of correlation IDs for problem-opening-events.

Example

In this example, the request pushes the CUSTOM_ANNOTATION event, which applies to all custom devices with the Coffee-2nd-floor tag. This annotation is a notification that these coffee machines are broken.

The API token is passed in the Authorization header.

Curl

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/v1/events \
  -H 'Authorization: Api-token abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \  
  -d '{
  "eventType": "CUSTOM_ANNOTATION",
  "timeoutMinutes": 0,
  "attachRules": {

    "tagRule": [
      {
        "meTypes": [
          "CUSTOM_DEVICE"
        ],
        "tags": [
          {
            "context": "CONTEXTLESS",
            "key": "IG-test"
          }
        ]
      }
    ]
  },
  "source": "OpsControl",
  "annotationType": "defect",
  "annotationDescription": "coffee machine is defective"
}'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/events

Request body

api-examples/events/post-event.json
Download
{
  "eventType": "CUSTOM_ANNOTATION",
  "timeoutMinutes": 0,
  "attachRules": {
    "tagRule": [
      {
        "meTypes": [
          "CUSTOM_DEVICE"
        ],
        "tags": [
          {
            "context": "CONTEXTLESS",
            "key": "IG-test"
          }
        ]
      }
    ]
  },
  "source": "OpsControl",
  "annotationType": "defect",
  "annotationDescription": "coffee machine is defective"
}

Response body

{
  "storedEventIds": [
    -6153476110846051426
  ],
  "storedIds": [
    "-6153476110846051426_1533300519291"
  ],
  "storedCorrelationIds": []
}

Response code

200