@@ -2176,6 +2176,89 @@ components:
2176
2176
- id
2177
2177
- base_severity
2178
2178
type: object
2179
+ AlertEventCustomAttributes:
2180
+ additionalProperties: false
2181
+ description: Object representing custom alert event attributes.
2182
+ properties:
2183
+ custom:
2184
+ $ref: '#/components/schemas/AlertEventCustomAttributesCustom'
2185
+ links:
2186
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinks'
2187
+ priority:
2188
+ $ref: '#/components/schemas/AlertEventCustomAttributesPriority'
2189
+ status:
2190
+ $ref: '#/components/schemas/AlertEventCustomAttributesStatus'
2191
+ type: object
2192
+ AlertEventCustomAttributesCustom:
2193
+ additionalProperties: {}
2194
+ description: Custom attributes. Support up to 100 properties and a maximum nesting
2195
+ depth of 10 levels.
2196
+ example: {}
2197
+ type: object
2198
+ AlertEventCustomAttributesLinks:
2199
+ description: The links related to the event.
2200
+ items:
2201
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
2202
+ maxItems: 20
2203
+ minItems: 1
2204
+ type: array
2205
+ AlertEventCustomAttributesLinksItems:
2206
+ description: A link.
2207
+ properties:
2208
+ category:
2209
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
2210
+ title:
2211
+ description: The title of the link. Limited to 300 characters.
2212
+ example: Runbook Link
2213
+ maxLength: 300
2214
+ type: string
2215
+ url:
2216
+ description: The URL of the link. Limited to 2048 characters.
2217
+ example: https://app.datadoghq.com/runbook
2218
+ maxLength: 2048
2219
+ type: string
2220
+ required:
2221
+ - url
2222
+ - category
2223
+ type: object
2224
+ AlertEventCustomAttributesLinksItemsCategory:
2225
+ description: The category of the link.
2226
+ enum:
2227
+ - runbook
2228
+ example: runbook
2229
+ type: string
2230
+ x-enum-varnames:
2231
+ - RUNBOOK
2232
+ AlertEventCustomAttributesPriority:
2233
+ description: The priority of the alert.
2234
+ enum:
2235
+ - '1'
2236
+ - '2'
2237
+ - '3'
2238
+ - '4'
2239
+ - '5'
2240
+ example: '1'
2241
+ type: string
2242
+ x-enum-varnames:
2243
+ - PRIORITY_ONE
2244
+ - PRIORITY_TWO
2245
+ - PRIORITY_THREE
2246
+ - PRIORITY_FOUR
2247
+ - PRIORITY_FIVE
2248
+ AlertEventCustomAttributesStatus:
2249
+ description: The status of the alert.
2250
+ enum:
2251
+ - info
2252
+ - warn
2253
+ - error
2254
+ - ok
2255
+ example: warn
2256
+ type: string
2257
+ x-enum-varnames:
2258
+ - INFO
2259
+ - WARN
2260
+ - ERROR
2261
+ - OK
2179
2262
Annotation:
2180
2263
description: A list of annotations used in the workflow. These are like sticky
2181
2264
notes for your workflow!
@@ -6868,6 +6951,7 @@ components:
6868
6951
type: integer
6869
6952
type: object
6870
6953
ChangeEventCustomAttributes:
6954
+ additionalProperties: false
6871
6955
description: Object representing custom change event attributes.
6872
6956
properties:
6873
6957
author:
@@ -6920,8 +7004,8 @@ components:
6920
7004
- changed_resource
6921
7005
type: object
6922
7006
ChangeEventCustomAttributesAuthor:
6923
- description: Object representing the entity which made the change. Optional
6924
- field but if provided should include ` type` and ` name` .
7007
+ description: Object representing the entity that made the change. Optional field
7008
+ but if provided should include type and name.
6925
7009
properties:
6926
7010
name:
6927
7011
description: Author's name. Limited to 128 characters.
@@ -14229,28 +14313,33 @@ components:
14229
14313
type: string
14230
14314
type: object
14231
14315
EventCategory:
14232
- description: Event category to identify the type of event. Only the value `change`
14233
- is supported. Support for other categories are coming. please reach out to
14234
- datadog support if you're interested.
14316
+ description: Event category to identify the type of event.
14235
14317
enum:
14236
14318
- change
14319
+ - alert
14237
14320
example: change
14238
14321
type: string
14239
14322
x-enum-varnames:
14240
14323
- CHANGE
14324
+ - ALERT
14241
14325
EventCreateRequest:
14242
14326
description: Object representing an event creation request.
14243
14327
properties:
14244
14328
attributes:
14245
14329
$ref: '#/components/schemas/EventPayload'
14246
14330
type:
14247
14331
$ref: '#/components/schemas/EventCreateRequestType'
14332
+ required:
14333
+ - type
14334
+ - attributes
14248
14335
type: object
14249
14336
EventCreateRequestPayload:
14250
14337
description: Payload for creating an event.
14251
14338
properties:
14252
14339
data:
14253
14340
$ref: '#/components/schemas/EventCreateRequest'
14341
+ required:
14342
+ - data
14254
14343
type: object
14255
14344
EventCreateRequestType:
14256
14345
description: Entity type.
@@ -14286,28 +14375,43 @@ components:
14286
14375
EventCreateResponseAttributesAttributesEvt:
14287
14376
description: JSON object of event system attributes.
14288
14377
properties:
14289
- id:
14290
- description: Event id
14378
+ uid:
14379
+ description: A unique identifier for the event. You can use this ID to query
14380
+ or reference the event in the V2 endpoint.
14291
14381
type: string
14292
14382
type: object
14293
14383
EventCreateResponsePayload:
14294
14384
description: Response containing information about created event.
14295
14385
properties:
14296
14386
data:
14297
14387
$ref: '#/components/schemas/EventCreateResponse'
14388
+ links:
14389
+ $ref: '#/components/schemas/EventCreateResponsePayloadLinks'
14390
+ type: object
14391
+ EventCreateResponsePayloadLinks:
14392
+ description: Links attributes.
14393
+ properties:
14394
+ self:
14395
+ description: The URL of the event. This link is only functional when using
14396
+ the default subdomain.
14397
+ type: string
14298
14398
type: object
14299
14399
EventPayload:
14300
14400
description: Event attributes.
14301
14401
properties:
14302
14402
aggregation_key:
14303
14403
description: An arbitrary string to use for aggregation when correlating
14304
- events. Limited to 100 characters.
14404
+ events. If you specify a key, events are deduplicated to alerts based
14405
+ on this key. Limited to 100 characters.
14406
+ example: aggregation_key_123
14305
14407
maxLength: 100
14306
14408
type: string
14307
14409
attributes:
14308
14410
$ref: '#/components/schemas/EventPayloadAttributes'
14309
14411
category:
14310
14412
$ref: '#/components/schemas/EventCategory'
14413
+ integration_id:
14414
+ $ref: '#/components/schemas/EventPayloadIntegrationId'
14311
14415
message:
14312
14416
description: The body of the event. Limited to 4000 characters.
14313
14417
example: payment_processed feature flag has been enabled
@@ -14321,7 +14425,10 @@ components:
14321
14425
- env:test
14322
14426
items:
14323
14427
description: A tag.
14428
+ maxLength: 200
14324
14429
type: string
14430
+ maxItems: 100
14431
+ minItems: 1
14325
14432
type: array
14326
14433
timestamp:
14327
14434
description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
@@ -14331,6 +14438,7 @@ components:
14331
14438
14332
14439
Defaults to the timestamp of receipt. Limited to values no older than
14333
14440
18 hours.'
14441
+ example: '2020-01-01T01:30:15.010000Z'
14334
14442
type: string
14335
14443
title:
14336
14444
description: The event title. Limited to 500 characters.
@@ -14343,10 +14451,20 @@ components:
14343
14451
- attributes
14344
14452
type: object
14345
14453
EventPayloadAttributes:
14346
- description: JSON object for custom attributes. Schema are different per each
14347
- event category.
14454
+ description: JSON object for custom attributes. Schema is different per event
14455
+ category.
14348
14456
oneOf:
14349
14457
- $ref: '#/components/schemas/ChangeEventCustomAttributes'
14458
+ - $ref: '#/components/schemas/AlertEventCustomAttributes'
14459
+ EventPayloadIntegrationId:
14460
+ description: Integration IDs sourced from integration manifests. Currently,
14461
+ only `custom-events` is supported.
14462
+ enum:
14463
+ - custom-events
14464
+ example: custom-events
14465
+ type: string
14466
+ x-enum-varnames:
14467
+ - CUSTOM_EVENTS
14350
14468
EventPriority:
14351
14469
description: The priority of the event's monitor. For example, `normal` or `low`.
14352
14470
enum:
@@ -45904,9 +46022,12 @@ paths:
45904
46022
- events_read
45905
46023
post:
45906
46024
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
45907
- with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
46025
+ with the `change` or `alert` category** are in General Availability. For change
46026
+ events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
45908
46027
for more details.\n\n\u274C For use cases involving other event categories,
45909
- please use the V1 endpoint."
46028
+ please use the V1 endpoint.\n\u274C Currently, notifications are not supported
46029
+ for events sent to this endpoint, please use the V1 endpoint for notification
46030
+ functionality."
45910
46031
operationId: CreateEvent
45911
46032
requestBody:
45912
46033
content:
@@ -45916,6 +46037,7 @@ paths:
45916
46037
value:
45917
46038
data:
45918
46039
attributes:
46040
+ aggregation_key: aggregation_key_123
45919
46041
attributes:
45920
46042
author:
45921
46043
name: datadog@datadog.com
@@ -45944,17 +46066,19 @@ paths:
45944
46066
rule:
45945
46067
datacenter: devcycle.us1.prod
45946
46068
category: change
46069
+ integration_id: custom-events
45947
46070
message: payment_processed feature flag has been enabled
45948
46071
tags:
45949
46072
- env:test
46073
+ timestamp: '2020-01-01T01:30:15.010000Z'
45950
46074
title: payment_processed feature flag updated
45951
46075
type: event
45952
46076
schema:
45953
46077
$ref: '#/components/schemas/EventCreateRequestPayload'
45954
46078
description: Event request object
45955
46079
required: true
45956
46080
responses:
45957
- '200 ':
46081
+ '202 ':
45958
46082
content:
45959
46083
application/json:
45960
46084
schema:
@@ -45977,6 +46101,38 @@ paths:
45977
46101
security:
45978
46102
- apiKeyAuth: []
45979
46103
appKeyAuth: []
46104
+ servers:
46105
+ - url: https://{subdomain}.{site}
46106
+ variables:
46107
+ site:
46108
+ default: datadoghq.com
46109
+ description: The regional site for customers.
46110
+ enum:
46111
+ - datadoghq.com
46112
+ - us3.datadoghq.com
46113
+ - us5.datadoghq.com
46114
+ - ap1.datadoghq.com
46115
+ - datadoghq.eu
46116
+ - ddog-gov.com
46117
+ subdomain:
46118
+ default: event-management-intake
46119
+ description: The subdomain where the API is deployed.
46120
+ - url: '{protocol}://{name}'
46121
+ variables:
46122
+ name:
46123
+ default: event-management-intake.datadoghq.com
46124
+ description: Full site DNS name.
46125
+ protocol:
46126
+ default: https
46127
+ description: The protocol for accessing the API.
46128
+ - url: https://{subdomain}.{site}
46129
+ variables:
46130
+ site:
46131
+ default: datadoghq.com
46132
+ description: Any Datadog deployment.
46133
+ subdomain:
46134
+ default: event-management-intake
46135
+ description: The subdomain where the API is deployed.
45980
46136
summary: Post an event
45981
46137
tags:
45982
46138
- Events
0 commit comments