@@ -2154,6 +2154,89 @@ components:
2154
2154
- id
2155
2155
- base_severity
2156
2156
type: object
2157
+ AlertEventCustomAttributes:
2158
+ additionalProperties: false
2159
+ description: Object representing custom alert event attributes.
2160
+ properties:
2161
+ custom:
2162
+ $ref: '#/components/schemas/AlertEventCustomAttributesCustom'
2163
+ links:
2164
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinks'
2165
+ priority:
2166
+ $ref: '#/components/schemas/AlertEventCustomAttributesPriority'
2167
+ status:
2168
+ $ref: '#/components/schemas/AlertEventCustomAttributesStatus'
2169
+ type: object
2170
+ AlertEventCustomAttributesCustom:
2171
+ additionalProperties: {}
2172
+ description: Custom attributes. Support up to 100 properties and a maximum nesting
2173
+ depth of 10 levels.
2174
+ example: {}
2175
+ type: object
2176
+ AlertEventCustomAttributesLinks:
2177
+ description: The links related to the event.
2178
+ items:
2179
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
2180
+ maxItems: 20
2181
+ minItems: 1
2182
+ type: array
2183
+ AlertEventCustomAttributesLinksItems:
2184
+ description: A link.
2185
+ properties:
2186
+ category:
2187
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
2188
+ title:
2189
+ description: The title of the link. Limited to 300 characters.
2190
+ example: Runbook Link
2191
+ maxLength: 300
2192
+ type: string
2193
+ url:
2194
+ description: The URL of the link. Limited to 2048 characters.
2195
+ example: https://app.datadoghq.com/runbook
2196
+ maxLength: 2048
2197
+ type: string
2198
+ required:
2199
+ - url
2200
+ - category
2201
+ type: object
2202
+ AlertEventCustomAttributesLinksItemsCategory:
2203
+ description: The category of the link.
2204
+ enum:
2205
+ - runbook
2206
+ example: runbook
2207
+ type: string
2208
+ x-enum-varnames:
2209
+ - RUNBOOK
2210
+ AlertEventCustomAttributesPriority:
2211
+ description: The priority of the alert.
2212
+ enum:
2213
+ - '1'
2214
+ - '2'
2215
+ - '3'
2216
+ - '4'
2217
+ - '5'
2218
+ example: '1'
2219
+ type: string
2220
+ x-enum-varnames:
2221
+ - PRIORITY_ONE
2222
+ - PRIORITY_TWO
2223
+ - PRIORITY_THREE
2224
+ - PRIORITY_FOUR
2225
+ - PRIORITY_FIVE
2226
+ AlertEventCustomAttributesStatus:
2227
+ description: The status of the alert.
2228
+ enum:
2229
+ - info
2230
+ - warn
2231
+ - error
2232
+ - ok
2233
+ example: warn
2234
+ type: string
2235
+ x-enum-varnames:
2236
+ - INFO
2237
+ - WARN
2238
+ - ERROR
2239
+ - OK
2157
2240
Annotation:
2158
2241
description: A list of annotations used in the workflow. These are like sticky
2159
2242
notes for your workflow!
@@ -6846,6 +6929,7 @@ components:
6846
6929
type: integer
6847
6930
type: object
6848
6931
ChangeEventCustomAttributes:
6932
+ additionalProperties: false
6849
6933
description: Object representing custom change event attributes.
6850
6934
properties:
6851
6935
author:
@@ -14207,28 +14291,34 @@ components:
14207
14291
type: string
14208
14292
type: object
14209
14293
EventCategory:
14210
- description: Event category to identify the type of event. Only the value `change`
14211
- is supported. Support for other categories are coming. please reach out to
14212
- datadog support if you're interested.
14294
+ description: Event category to identify the type of event. For example, `change`
14295
+ or `alert`.
14213
14296
enum:
14214
14297
- change
14298
+ - alert
14215
14299
example: change
14216
14300
type: string
14217
14301
x-enum-varnames:
14218
14302
- CHANGE
14303
+ - ALERT
14219
14304
EventCreateRequest:
14220
14305
description: Object representing an event creation request.
14221
14306
properties:
14222
14307
attributes:
14223
14308
$ref: '#/components/schemas/EventPayload'
14224
14309
type:
14225
14310
$ref: '#/components/schemas/EventCreateRequestType'
14311
+ required:
14312
+ - type
14313
+ - attributes
14226
14314
type: object
14227
14315
EventCreateRequestPayload:
14228
14316
description: Payload for creating an event.
14229
14317
properties:
14230
14318
data:
14231
14319
$ref: '#/components/schemas/EventCreateRequest'
14320
+ required:
14321
+ - data
14232
14322
type: object
14233
14323
EventCreateRequestType:
14234
14324
description: Entity type.
@@ -14264,28 +14354,42 @@ components:
14264
14354
EventCreateResponseAttributesAttributesEvt:
14265
14355
description: JSON object of event system attributes.
14266
14356
properties:
14267
- id:
14268
- description: Event id
14357
+ uid:
14358
+ description: A unique identifier for the event. You can use this ID to query
14359
+ or reference the event in the V2 endpoint.
14269
14360
type: string
14270
14361
type: object
14271
14362
EventCreateResponsePayload:
14272
14363
description: Response containing information about created event.
14273
14364
properties:
14274
14365
data:
14275
14366
$ref: '#/components/schemas/EventCreateResponse'
14367
+ links:
14368
+ $ref: '#/components/schemas/EventCreateResponsePayloadLinks'
14369
+ type: object
14370
+ EventCreateResponsePayloadLinks:
14371
+ description: Links attributes.
14372
+ properties:
14373
+ self:
14374
+ description: The URL of the event. This link is only functional when using
14375
+ the default subdomain.
14376
+ type: string
14276
14377
type: object
14277
14378
EventPayload:
14278
14379
description: Event attributes.
14279
14380
properties:
14280
14381
aggregation_key:
14281
14382
description: An arbitrary string to use for aggregation when correlating
14282
14383
events. Limited to 100 characters.
14384
+ example: aggregation_key_123
14283
14385
maxLength: 100
14284
14386
type: string
14285
14387
attributes:
14286
14388
$ref: '#/components/schemas/EventPayloadAttributes'
14287
14389
category:
14288
14390
$ref: '#/components/schemas/EventCategory'
14391
+ integration_id:
14392
+ $ref: '#/components/schemas/EventPayloadIntegrationId'
14289
14393
message:
14290
14394
description: The body of the event. Limited to 4000 characters.
14291
14395
example: payment_processed feature flag has been enabled
@@ -14299,7 +14403,10 @@ components:
14299
14403
- env:test
14300
14404
items:
14301
14405
description: A tag.
14406
+ maxLength: 200
14302
14407
type: string
14408
+ maxItems: 100
14409
+ minItems: 1
14303
14410
type: array
14304
14411
timestamp:
14305
14412
description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
@@ -14325,6 +14432,16 @@ components:
14325
14432
event category.
14326
14433
oneOf:
14327
14434
- $ref: '#/components/schemas/ChangeEventCustomAttributes'
14435
+ - $ref: '#/components/schemas/AlertEventCustomAttributes'
14436
+ EventPayloadIntegrationId:
14437
+ description: Integration IDs sourced from integration manifests. Currently,
14438
+ only `custom-events` is supported.
14439
+ enum:
14440
+ - custom-events
14441
+ example: custom-events
14442
+ type: string
14443
+ x-enum-varnames:
14444
+ - CUSTOM_EVENTS
14328
14445
EventPriority:
14329
14446
description: The priority of the event's monitor. For example, `normal` or `low`.
14330
14447
enum:
@@ -45705,9 +45822,12 @@ paths:
45705
45822
- events_read
45706
45823
post:
45707
45824
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
45708
- with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
45825
+ with the `change` or `alert` category** are in General Availability. For change
45826
+ events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
45709
45827
for more details.\n\n\u274C For use cases involving other event categories,
45710
- please use the V1 endpoint."
45828
+ please use the V1 endpoint.\n\u274C Currently, notifications are not supported
45829
+ for events sent to this endpoint, please use the V1 endpoint for notification
45830
+ functionality."
45711
45831
operationId: CreateEvent
45712
45832
requestBody:
45713
45833
content:
@@ -45717,6 +45837,7 @@ paths:
45717
45837
value:
45718
45838
data:
45719
45839
attributes:
45840
+ aggregation_key: aggregation_key_123
45720
45841
attributes:
45721
45842
author:
45722
45843
name: datadog@datadog.com
@@ -45745,17 +45866,19 @@ paths:
45745
45866
rule:
45746
45867
datacenter: devcycle.us1.prod
45747
45868
category: change
45869
+ integration_id: custom-events
45748
45870
message: payment_processed feature flag has been enabled
45749
45871
tags:
45750
45872
- env:test
45873
+ timestamp: '2020-01-01T01:30:15.010000Z'
45751
45874
title: payment_processed feature flag updated
45752
45875
type: event
45753
45876
schema:
45754
45877
$ref: '#/components/schemas/EventCreateRequestPayload'
45755
45878
description: Event request object
45756
45879
required: true
45757
45880
responses:
45758
- '200 ':
45881
+ '202 ':
45759
45882
content:
45760
45883
application/json:
45761
45884
schema:
@@ -45778,6 +45901,38 @@ paths:
45778
45901
security:
45779
45902
- apiKeyAuth: []
45780
45903
appKeyAuth: []
45904
+ servers:
45905
+ - url: https://{subdomain}.{site}
45906
+ variables:
45907
+ site:
45908
+ default: datadoghq.com
45909
+ description: The regional site for customers.
45910
+ enum:
45911
+ - datadoghq.com
45912
+ - us3.datadoghq.com
45913
+ - us5.datadoghq.com
45914
+ - ap1.datadoghq.com
45915
+ - datadoghq.eu
45916
+ - ddog-gov.com
45917
+ subdomain:
45918
+ default: event-management-intake
45919
+ description: The subdomain where the API is deployed.
45920
+ - url: '{protocol}://{name}'
45921
+ variables:
45922
+ name:
45923
+ default: event-management-intake.datadoghq.com
45924
+ description: Full site DNS name.
45925
+ protocol:
45926
+ default: https
45927
+ description: The protocol for accessing the API.
45928
+ - url: https://{subdomain}.{site}
45929
+ variables:
45930
+ site:
45931
+ default: datadoghq.com
45932
+ description: Any Datadog deployment.
45933
+ subdomain:
45934
+ default: event-management-intake
45935
+ description: The subdomain where the API is deployed.
45781
45936
summary: Post an event
45782
45937
tags:
45783
45938
- Events
0 commit comments