@@ -2165,6 +2165,89 @@ components:
2165
2165
- id
2166
2166
- base_severity
2167
2167
type: object
2168
+ AlertEventCustomAttributes:
2169
+ additionalProperties: false
2170
+ description: Object representing custom alert event attributes.
2171
+ properties:
2172
+ custom:
2173
+ $ref: '#/components/schemas/AlertEventCustomAttributesCustom'
2174
+ links:
2175
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinks'
2176
+ priority:
2177
+ $ref: '#/components/schemas/AlertEventCustomAttributesPriority'
2178
+ status:
2179
+ $ref: '#/components/schemas/AlertEventCustomAttributesStatus'
2180
+ type: object
2181
+ AlertEventCustomAttributesCustom:
2182
+ additionalProperties: {}
2183
+ description: Custom attributes support up to 100 properties and a maximum nesting
2184
+ depth of 10 levels.
2185
+ example: {}
2186
+ type: object
2187
+ AlertEventCustomAttributesLinks:
2188
+ description: The links related to the event.
2189
+ items:
2190
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
2191
+ maxItems: 20
2192
+ minItems: 1
2193
+ type: array
2194
+ AlertEventCustomAttributesLinksItems:
2195
+ description: A link.
2196
+ properties:
2197
+ category:
2198
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
2199
+ title:
2200
+ description: The title of the link.
2201
+ example: Runbook Link
2202
+ maxLength: 300
2203
+ type: string
2204
+ url:
2205
+ description: The URL of the link.
2206
+ example: https://app.datadoghq.com/runbook
2207
+ maxLength: 2048
2208
+ type: string
2209
+ required:
2210
+ - url
2211
+ - category
2212
+ type: object
2213
+ AlertEventCustomAttributesLinksItemsCategory:
2214
+ description: The category of the link.
2215
+ enum:
2216
+ - runbook
2217
+ example: runbook
2218
+ type: string
2219
+ x-enum-varnames:
2220
+ - RUNBOOK
2221
+ AlertEventCustomAttributesPriority:
2222
+ description: The priority of the alert.
2223
+ enum:
2224
+ - '1'
2225
+ - '2'
2226
+ - '3'
2227
+ - '4'
2228
+ - '5'
2229
+ example: '1'
2230
+ type: string
2231
+ x-enum-varnames:
2232
+ - PRIORITY_ONE
2233
+ - PRIORITY_TWO
2234
+ - PRIORITY_THREE
2235
+ - PRIORITY_FOUR
2236
+ - PRIORITY_FIVE
2237
+ AlertEventCustomAttributesStatus:
2238
+ description: The status of the alert.
2239
+ enum:
2240
+ - info
2241
+ - warn
2242
+ - error
2243
+ - ok
2244
+ example: warn
2245
+ type: string
2246
+ x-enum-varnames:
2247
+ - INFO
2248
+ - WARN
2249
+ - ERROR
2250
+ - OK
2168
2251
Annotation:
2169
2252
description: A list of annotations used in the workflow. These are like sticky
2170
2253
notes for your workflow!
@@ -13829,28 +13912,34 @@ components:
13829
13912
type: string
13830
13913
type: object
13831
13914
EventCategory:
13832
- description: Event category to identify the type of event. Only the value `change`
13833
- is supported. Support for other categories are coming. please reach out to
13834
- datadog support if you're interested.
13915
+ description: Event category to identify the type of event. For example, `change`
13916
+ or `alert`.
13835
13917
enum:
13836
13918
- change
13919
+ - alert
13837
13920
example: change
13838
13921
type: string
13839
13922
x-enum-varnames:
13840
13923
- CHANGE
13924
+ - ALERT
13841
13925
EventCreateRequest:
13842
13926
description: Object representing an event creation request.
13843
13927
properties:
13844
13928
attributes:
13845
13929
$ref: '#/components/schemas/EventPayload'
13846
13930
type:
13847
13931
$ref: '#/components/schemas/EventCreateRequestType'
13932
+ required:
13933
+ - type
13934
+ - attributes
13848
13935
type: object
13849
13936
EventCreateRequestPayload:
13850
13937
description: Payload for creating an event.
13851
13938
properties:
13852
13939
data:
13853
13940
$ref: '#/components/schemas/EventCreateRequest'
13941
+ required:
13942
+ - data
13854
13943
type: object
13855
13944
EventCreateRequestType:
13856
13945
description: Entity type.
@@ -13865,6 +13954,10 @@ components:
13865
13954
properties:
13866
13955
attributes:
13867
13956
$ref: '#/components/schemas/EventCreateResponseAttributes'
13957
+ id:
13958
+ description: Event ID
13959
+ example: _
13960
+ type: string
13868
13961
type:
13869
13962
description: Event type
13870
13963
example: event
@@ -13886,28 +13979,46 @@ components:
13886
13979
EventCreateResponseAttributesAttributesEvt:
13887
13980
description: JSON object of event system attributes.
13888
13981
properties:
13889
- id:
13890
- description: Event id
13982
+ uid:
13983
+ description: Event UID
13984
+ example: ABCDEFGHIJKLMNOPQRSTUVWX
13891
13985
type: string
13892
13986
type: object
13893
13987
EventCreateResponsePayload:
13894
13988
description: Response containing information about created event.
13895
13989
properties:
13896
13990
data:
13897
13991
$ref: '#/components/schemas/EventCreateResponse'
13992
+ links:
13993
+ $ref: '#/components/schemas/EventCreateResponsePayloadLinks'
13994
+ type: object
13995
+ EventCreateResponsePayloadLinks:
13996
+ description: Links attributes.
13997
+ properties:
13998
+ self:
13999
+ description: The URL of the event.
14000
+ example: https://app.datadoghq.com/event/event?id=123
14001
+ type: string
13898
14002
type: object
13899
14003
EventPayload:
13900
14004
description: Event attributes.
13901
14005
properties:
13902
14006
aggregation_key:
13903
14007
description: An arbitrary string to use for aggregation when correlating
13904
14008
events. Limited to 100 characters.
14009
+ example: aggregation_key_123
13905
14010
maxLength: 100
13906
14011
type: string
13907
14012
attributes:
13908
14013
$ref: '#/components/schemas/EventPayloadAttributes'
13909
14014
category:
13910
14015
$ref: '#/components/schemas/EventCategory'
14016
+ integration_id:
14017
+ description: Integration IDs sourced from manifests. Examples include custom-events,
14018
+ containerd, docker, elasticsearch, helm, mongodb, mysql, and nagios. See
14019
+ the full list of available IDs [here](https://docs.datadoghq.com/getting_started/integrations/).
14020
+ example: custom-events
14021
+ type: string
13911
14022
message:
13912
14023
description: The body of the event. Limited to 4000 characters.
13913
14024
example: payment_processed feature flag has been enabled
@@ -13921,7 +14032,10 @@ components:
13921
14032
- env:test
13922
14033
items:
13923
14034
description: A tag.
14035
+ maxLength: 200
13924
14036
type: string
14037
+ maxItems: 100
14038
+ minItems: 1
13925
14039
type: array
13926
14040
timestamp:
13927
14041
description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
@@ -13947,6 +14061,7 @@ components:
13947
14061
event category.
13948
14062
oneOf:
13949
14063
- $ref: '#/components/schemas/ChangeEventCustomAttributes'
14064
+ - $ref: '#/components/schemas/AlertEventCustomAttributes'
13950
14065
EventPriority:
13951
14066
description: The priority of the event's monitor. For example, `normal` or `low`.
13952
14067
enum:
@@ -46413,7 +46528,8 @@ paths:
46413
46528
type: safe
46414
46529
post:
46415
46530
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
46416
- with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
46531
+ with the `change` or `alert` category** are in General Availability. For change
46532
+ events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
46417
46533
for more details.\n\n\u274C For use cases involving other event categories,
46418
46534
please use the V1 endpoint."
46419
46535
operationId: CreateEvent
@@ -46425,6 +46541,7 @@ paths:
46425
46541
value:
46426
46542
data:
46427
46543
attributes:
46544
+ aggregation_key: aggregation_key_123
46428
46545
attributes:
46429
46546
author:
46430
46547
@@ -46453,6 +46570,7 @@ paths:
46453
46570
rule:
46454
46571
datacenter: devcycle.us1.prod
46455
46572
category: change
46573
+ integration_id: custom-events
46456
46574
message: payment_processed feature flag has been enabled
46457
46575
tags:
46458
46576
- env:test
@@ -46486,6 +46604,38 @@ paths:
46486
46604
security:
46487
46605
- apiKeyAuth: []
46488
46606
appKeyAuth: []
46607
+ servers:
46608
+ - url: https://{subdomain}.{site}
46609
+ variables:
46610
+ site:
46611
+ default: datadoghq.com
46612
+ description: The regional site for customers.
46613
+ enum:
46614
+ - datadoghq.com
46615
+ - us3.datadoghq.com
46616
+ - us5.datadoghq.com
46617
+ - ap1.datadoghq.com
46618
+ - datadoghq.eu
46619
+ - ddog-gov.com
46620
+ subdomain:
46621
+ default: event-management-intake
46622
+ description: The subdomain where the API is deployed.
46623
+ - url: '{protocol}://{name}'
46624
+ variables:
46625
+ name:
46626
+ default: event-management-intake.datadoghq.com
46627
+ description: Full site DNS name.
46628
+ protocol:
46629
+ default: https
46630
+ description: The protocol for accessing the API.
46631
+ - url: https://{subdomain}.{site}
46632
+ variables:
46633
+ site:
46634
+ default: datadoghq.com
46635
+ description: Any Datadog deployment.
46636
+ subdomain:
46637
+ default: event-management-intake
46638
+ description: The subdomain where the API is deployed.
46489
46639
summary: Post an event
46490
46640
tags:
46491
46641
- Events
0 commit comments