Settings API - Capture business events with OneAgent schema table
Capture business events with OneAgent (builtin:bizevents.http.incoming)
OneAgent can capture business events from incoming HTTP requests. To activate this feature, add capture rules below.
Capture rules tell OneAgent to capture business events when specific webservices or endpoints are called. A capture rule consists of trigger rules, mandatory business event information (e.g. type and provider) and optional event data fields. A trigger defines the criteria that, when met, cause a business event to be captured (e.g. endpoint “/api/buy” is called). By adding event data fields to your business event, you can extract data directly from the incoming request payload. To limit the scope of a capture rule to a certain Host-Group or Host, create the rule directly in the Host-Group or Host setting screen.
Learn more by visiting our documentation.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:bizevents.http.incoming |
| HOST - HostHOST_GROUP - Host Groupenvironment |
Parameters
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Enabled | boolean | - | required |
| ruleName | Rule name | text | - | required |
| triggers | Triggers | set | Define conditions to trigger business events from incoming web requests. Whenever one condition applies the event gets captured. | required |
| event | Event meta data | EventComplex | - | required |
Request body objects
The EventAttributeComplex object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| sourceType | Data source | enum | - | required |
| source | Fixed value | text | - | required |
| path | Path | text | required |
The EventCategoryAttributeComplex object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| sourceType | Data source | enum | - | required |
| source | Fixed value | text | - | required |
| path | Path | text | required |
The EventDataAttributeComplex object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| sourceType | Data source | enum | - | required |
| source | Fixed value | text | - | required |
| path | Path | text | required |
The EventDataFieldComplex object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| name | Field name | text | Field name to be added to data. | required |
| source | - | EventDataAttributeComplex | - | required |
The DataSourceComplex object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| dataSource | Data source | enum | - | required |
| path | Path | text | required |
The MatcherComplex object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| source | - | DataSourceComplex | - | required |
| type | Operator | enum | - | required |
| value | Value | text | - | required |
| caseSensitive | Case sensitive | boolean | - | required |
The EventComplex object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| provider | - | EventAttributeComplex | Event provider | required |
| type | - | EventAttributeComplex | Event type | required |
| category | - | EventCategoryAttributeComplex | Event category | required |
| data | Event data | set | Additional attributes for the business event. | required |