Business event capture

• Latest Dynatrace
• How-to guide
• 14-min read
• Updated on Sep 04, 2025

To get started with business events, you first need to define the scope of the data you want to capture. The approach you use depends on the source of the business events.

There are five sources for business events.

Get business events via OneAgent

OneAgent version 1.253+

To capture business events using OneAgent, you need to first enable the feature.

Configuration requires one or more capture rules that consist of triggers, mandatory data fields, and optional event data fields.

The table below contains examples of mandatory (event.type, event.provider) and optional (event.category) data fields.

Supported technologies

Supported technologies for data extraction from HTTP requests are listed in the tables below.

Data extraction from incoming HTTP requests

Data extraction from outgoing HTTP requests

Capturing variants

This feature is available for OneAgent version 1.309+ on Webserver, .NET and Java. For all other technologies, apply the technology support table.

Define how incoming business events should be parsed based on their content-type.

To access the default configuration, Search for Capturing variants and select it.

Those settings apply on the global level and are therefore used for all deployed agents on supported technologies.

Configure business event sources on OneAgent

OneAgent version 1.253+

To configure business event sources on OneAgent

Example of data extraction from JSON payloads

The following table shows additional examples of how to extract data from JSON payloads.

Examples of data extraction from XML payloads

The extraction of data from XML payloads works with the same syntax as for JSON.

Example 1: Extracting attributes and values from basic XML

<LogoutRequest id=”102030AF”>
      <accountId>100</accountId>
</LogoutRequest>

Example 2: Extracting attributes and values from XML with namespaces

<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <Tagh1 xmlns="http://tempuri.org/">
         <Tagh2 cusType="A" xmlns:a="http://schemas.datacontract.org/ex" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:Code i:nil="true" />
            <a:Name>MyCustomer1</a:Name>
            <a:TotalValue>45</a:TotalValue>
         </Tagh2>
      </Tagh1>
   </s:Body>
</s:Envelope>

Examples of data capture from requests and responses

Data capture from requests and responses is available for both JSON and XML.

The following table shows examples of how to extract data from requests and is based on the JSON payload example above.

Get business events from RUM

Business events are available for all Dynatrace RUM technologies (web RUM, mobile RUM, and OpenKit). RUM business events can be obtained by leveraging a dedicated method of the RUM JavaScript, OneAgent for mobile, or OpenKit.

Check the sections below for instructions on how to report business events for different platforms.

RUM JavaScript

Android

iOS

Cordova¹

Xamarin

Flutter

.NET MAUI

React Native

OpenKit

let attributes = {
    "event.name": "Confirmed Booking",
    "page": "booking-confirmation",
    "product": "Danube Anna Hotel",
    "amount": 358.35,
    "currency": "USD",
    "reviewScore": 4.8,
    "arrivalDate": "2022-11-05",
    "departureDate": "2022-11-15",
    "journeyDuration": 10,
    "adultTravelers": 2,
    "childrenTravelers": 0
};

dynatrace.sendBizEvent('com.easytravel.funnel.booking-finished', attributes);

Log to Business events

Use OpenPipeline to convert incoming logs to business events. This is useful if logs contain business-relevant information or no other ingest path for business events is available.

See the following log example to get started:

{

"content": "{\"user\": \"009494\", \"ordervalue\": 1000}"

}

Generate business events from Workflows

You can generate business events from workflows to capture and persist business-grade data. Examples of how this can be used include:

You can generate business events as a workflow action by selecting the Ingest business event action type.

The Ingest business event action can take data either from user-provided JSON data, or by executing DQL. For example:

In addition to the Business event data source, Ingest from attribute, default values for Event provider, Event type, and Event category attributes should be provided to generate the business event. These values might be overridden by the data provided in the JSON or DQL statement. For example, if your DQL query returns a value for event.type, this value will be written to the business event instead of the default value.

If default values aren't provided, event.provider and event.type will be assigned attribute value Unknown when the event is generated, while event.category will be assigned attribute value Other.

The Business event data can include one or more events to be generated. This applies to both DQL and JSON options:

After the successful execution of the workflow and the Ingest business event action, business events will be generated based on your parameters. The following is an example of a successful execution:

Handling JSON response data

Some use cases require you to use JSON data returned by an API call from a previous workflow action, and convert it into correct JSON that can be used with Ingest business event. For example, let's say you want to ingest currency rates from an external service on a daily basis and persist them as business events that can be used in other queries. To do that, you can define a workflow that triggers two steps:

The HTTP request returns the JSON payload content in the following format:

{

      "success": true,

      "timestamp": 1754946555,

      "base": "EUR",

      "date": "2025-08-11",

      "rates": {

            "USD": 1.161388,

            "JPY": 171.953923,

            "AUD": 1.78907,

            "CAD": 1.600567

      }

}

For our use case, we want to keep only the rates data.

Next, you need to configure the Ingest business event action. To do that

After the workflow is executed, you can query the business event and get the following data:

To extract individual rates from the event, use the following DQL:

fetch bizevents

| filter event.type == "currency"

| parse rates, "JSON:rates"

| fields aud = rates[AUD], usd=rates[USD]