@@ -2138,6 +2138,86 @@ components:
2138
2138
- id
2139
2139
- base_severity
2140
2140
type: object
2141
+ AlertEventCustomAttributes:
2142
+ description: Object representing custom alert event attributes.
2143
+ properties:
2144
+ custom:
2145
+ $ref: '#/components/schemas/AlertEventCustomAttributesCustom'
2146
+ links:
2147
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinks'
2148
+ priority:
2149
+ $ref: '#/components/schemas/AlertEventCustomAttributesPriority'
2150
+ status:
2151
+ $ref: '#/components/schemas/AlertEventCustomAttributesStatus'
2152
+ type: object
2153
+ AlertEventCustomAttributesCustom:
2154
+ description: Custom attributes. Maximum 100 properties. Maximum 10 nested levels.
2155
+ example: {}
2156
+ type: object
2157
+ AlertEventCustomAttributesLinks:
2158
+ description: The links related to the event.
2159
+ items:
2160
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
2161
+ maxItems: 20
2162
+ minItems: 1
2163
+ type: array
2164
+ AlertEventCustomAttributesLinksItems:
2165
+ description: A link.
2166
+ properties:
2167
+ category:
2168
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
2169
+ title:
2170
+ description: The title of the link.
2171
+ example: Runbook Link
2172
+ maxLength: 300
2173
+ type: string
2174
+ url:
2175
+ description: The URL of the link.
2176
+ example: https://app.datadoghq.com/runbook
2177
+ maxLength: 2048
2178
+ type: string
2179
+ required:
2180
+ - url
2181
+ - category
2182
+ type: object
2183
+ AlertEventCustomAttributesLinksItemsCategory:
2184
+ description: The category of the link.
2185
+ enum:
2186
+ - runbook
2187
+ example: runbook
2188
+ type: string
2189
+ x-enum-varnames:
2190
+ - RUNBOOK
2191
+ AlertEventCustomAttributesPriority:
2192
+ description: The priority of the alert.
2193
+ enum:
2194
+ - '1'
2195
+ - '2'
2196
+ - '3'
2197
+ - '4'
2198
+ - '5'
2199
+ example: '1'
2200
+ type: string
2201
+ x-enum-varnames:
2202
+ - PRIORITY_ONE
2203
+ - PRIORITY_TWO
2204
+ - PRIORITY_THREE
2205
+ - PRIORITY_FOUR
2206
+ - PRIORITY_FIVE
2207
+ AlertEventCustomAttributesStatus:
2208
+ description: The status of the alert.
2209
+ enum:
2210
+ - info
2211
+ - warn
2212
+ - error
2213
+ - ok
2214
+ example: warn
2215
+ type: string
2216
+ x-enum-varnames:
2217
+ - INFO
2218
+ - WARN
2219
+ - ERROR
2220
+ - OK
2141
2221
Annotation:
2142
2222
description: A list of annotations used in the workflow. These are like sticky
2143
2223
notes for your workflow!
@@ -13949,28 +14029,35 @@ components:
13949
14029
type: string
13950
14030
type: object
13951
14031
EventCategory:
13952
- description: Event category to identify the type of event. Only the value `change`
13953
- is supported . Support for other categories are coming. please reach out to
13954
- datadog support if you're interested.
14032
+ description: Event category to identify the type of event. For example, `change`
14033
+ or `alert` . Support for other categories are coming. please reach out to datadog
14034
+ support if you're interested.
13955
14035
enum:
13956
14036
- change
14037
+ - alert
13957
14038
example: change
13958
14039
type: string
13959
14040
x-enum-varnames:
13960
14041
- CHANGE
14042
+ - ALERT
13961
14043
EventCreateRequest:
13962
14044
description: Object representing an event creation request.
13963
14045
properties:
13964
14046
attributes:
13965
14047
$ref: '#/components/schemas/EventPayload'
13966
14048
type:
13967
14049
$ref: '#/components/schemas/EventCreateRequestType'
14050
+ required:
14051
+ - type
14052
+ - attributes
13968
14053
type: object
13969
14054
EventCreateRequestPayload:
13970
14055
description: Payload for creating an event.
13971
14056
properties:
13972
14057
data:
13973
14058
$ref: '#/components/schemas/EventCreateRequest'
14059
+ required:
14060
+ - data
13974
14061
type: object
13975
14062
EventCreateRequestType:
13976
14063
description: Entity type.
@@ -13985,6 +14072,10 @@ components:
13985
14072
properties:
13986
14073
attributes:
13987
14074
$ref: '#/components/schemas/EventCreateResponseAttributes'
14075
+ id:
14076
+ description: Event ID
14077
+ example: _
14078
+ type: string
13988
14079
type:
13989
14080
description: Event type
13990
14081
example: event
@@ -14006,28 +14097,46 @@ components:
14006
14097
EventCreateResponseAttributesAttributesEvt:
14007
14098
description: JSON object of event system attributes.
14008
14099
properties:
14009
- id:
14010
- description: Event id
14100
+ uid:
14101
+ description: Event UID
14102
+ example: ABCDEFGHIJKLMNOPQRSTUVWX
14011
14103
type: string
14012
14104
type: object
14013
14105
EventCreateResponsePayload:
14014
14106
description: Response containing information about created event.
14015
14107
properties:
14016
14108
data:
14017
14109
$ref: '#/components/schemas/EventCreateResponse'
14110
+ links:
14111
+ $ref: '#/components/schemas/EventCreateResponsePayloadLinks'
14112
+ type: object
14113
+ EventCreateResponsePayloadLinks:
14114
+ description: Links attributes.
14115
+ properties:
14116
+ self:
14117
+ description: The URL of the event.
14118
+ example: https://app.datadoghq.com/event/event?id=123
14119
+ type: string
14018
14120
type: object
14019
14121
EventPayload:
14020
14122
description: Event attributes.
14021
14123
properties:
14022
14124
aggregation_key:
14023
14125
description: An arbitrary string to use for aggregation when correlating
14024
14126
events. Limited to 100 characters.
14127
+ example: aggregation_key_123
14025
14128
maxLength: 100
14026
14129
type: string
14027
14130
attributes:
14028
14131
$ref: '#/components/schemas/EventPayloadAttributes'
14029
14132
category:
14030
14133
$ref: '#/components/schemas/EventCategory'
14134
+ integration_id:
14135
+ description: Integration IDs fetched from manifests. Option examples include
14136
+ custom-events, containerd, docker, elasticsearch, helm, mongodb, mysql,
14137
+ nagios etc. A complete list of integration ID values available here.
14138
+ example: custom-events
14139
+ type: string
14031
14140
message:
14032
14141
description: The body of the event. Limited to 4000 characters.
14033
14142
example: payment_processed feature flag has been enabled
@@ -14041,7 +14150,10 @@ components:
14041
14150
- env:test
14042
14151
items:
14043
14152
description: A tag.
14153
+ maxLength: 200
14044
14154
type: string
14155
+ maxItems: 100
14156
+ minItems: 1
14045
14157
type: array
14046
14158
timestamp:
14047
14159
description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
@@ -14051,6 +14163,7 @@ components:
14051
14163
14052
14164
Defaults to the timestamp of receipt. Limited to values no older than
14053
14165
18 hours.'
14166
+ example: '2025-01-15T01:30:15.010000Z'
14054
14167
type: string
14055
14168
title:
14056
14169
description: The event title. Limited to 500 characters.
@@ -14067,6 +14180,7 @@ components:
14067
14180
event category.
14068
14181
oneOf:
14069
14182
- $ref: '#/components/schemas/ChangeEventCustomAttributes'
14183
+ - $ref: '#/components/schemas/AlertEventCustomAttributes'
14070
14184
EventPriority:
14071
14185
description: The priority of the event's monitor. For example, `normal` or `low`.
14072
14186
enum:
@@ -45283,7 +45397,8 @@ paths:
45283
45397
- events_read
45284
45398
post:
45285
45399
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
45286
- with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
45400
+ with the `change` or `alert` category** are in General Availability. For change
45401
+ events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
45287
45402
for more details.\n\n\u274C For use cases involving other event categories,
45288
45403
please use the V1 endpoint."
45289
45404
operationId: CreateEvent
@@ -45295,6 +45410,7 @@ paths:
45295
45410
value:
45296
45411
data:
45297
45412
attributes:
45413
+ aggregation_key: aggregation_key_123
45298
45414
attributes:
45299
45415
author:
45300
45416
@@ -45323,9 +45439,11 @@ paths:
45323
45439
rule:
45324
45440
datacenter: devcycle.us1.prod
45325
45441
category: change
45442
+ integration_id: custom-events
45326
45443
message: payment_processed feature flag has been enabled
45327
45444
tags:
45328
45445
- env:test
45446
+ timestamp: '2025-01-15T01:30:15.010000Z'
45329
45447
title: payment_processed feature flag updated
45330
45448
type: event
45331
45449
schema:
@@ -45356,6 +45474,38 @@ paths:
45356
45474
security:
45357
45475
- apiKeyAuth: []
45358
45476
appKeyAuth: []
45477
+ servers:
45478
+ - url: https://{subdomain}.{site}
45479
+ variables:
45480
+ site:
45481
+ default: datadoghq.com
45482
+ description: The regional site for customers.
45483
+ enum:
45484
+ - datadoghq.com
45485
+ - us3.datadoghq.com
45486
+ - us5.datadoghq.com
45487
+ - ap1.datadoghq.com
45488
+ - datadoghq.eu
45489
+ - ddog-gov.com
45490
+ subdomain:
45491
+ default: event-management-intake
45492
+ description: The subdomain where the API is deployed.
45493
+ - url: '{protocol}://{name}'
45494
+ variables:
45495
+ name:
45496
+ default: event-management-intake.datadoghq.com
45497
+ description: Full site DNS name.
45498
+ protocol:
45499
+ default: https
45500
+ description: The protocol for accessing the API.
45501
+ - url: https://{subdomain}.{site}
45502
+ variables:
45503
+ site:
45504
+ default: datadoghq.com
45505
+ description: Any Datadog deployment.
45506
+ subdomain:
45507
+ default: event-management-intake
45508
+ description: The subdomain where the API is deployed.
45359
45509
summary: Post an event
45360
45510
tags:
45361
45511
- Events
0 commit comments