@@ -2138,6 +2138,89 @@ components:
2138
2138
- id
2139
2139
- base_severity
2140
2140
type: object
2141
+ AlertEventCustomAttributes:
2142
+ additionalProperties: false
2143
+ description: Object representing custom alert event attributes.
2144
+ properties:
2145
+ custom:
2146
+ $ref: '#/components/schemas/AlertEventCustomAttributesCustom'
2147
+ links:
2148
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinks'
2149
+ priority:
2150
+ $ref: '#/components/schemas/AlertEventCustomAttributesPriority'
2151
+ status:
2152
+ $ref: '#/components/schemas/AlertEventCustomAttributesStatus'
2153
+ type: object
2154
+ AlertEventCustomAttributesCustom:
2155
+ additionalProperties: {}
2156
+ description: Custom attributes. Support up to 100 properties and a maximum nesting
2157
+ depth of 10 levels.
2158
+ example: {}
2159
+ type: object
2160
+ AlertEventCustomAttributesLinks:
2161
+ description: The links related to the event.
2162
+ items:
2163
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
2164
+ maxItems: 20
2165
+ minItems: 1
2166
+ type: array
2167
+ AlertEventCustomAttributesLinksItems:
2168
+ description: A link.
2169
+ properties:
2170
+ category:
2171
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
2172
+ title:
2173
+ description: The title of the link. Limited to 300 characters.
2174
+ example: Runbook Link
2175
+ maxLength: 300
2176
+ type: string
2177
+ url:
2178
+ description: The URL of the link. Limited to 2048 characters.
2179
+ example: https://app.datadoghq.com/runbook
2180
+ maxLength: 2048
2181
+ type: string
2182
+ required:
2183
+ - url
2184
+ - category
2185
+ type: object
2186
+ AlertEventCustomAttributesLinksItemsCategory:
2187
+ description: The category of the link.
2188
+ enum:
2189
+ - runbook
2190
+ example: runbook
2191
+ type: string
2192
+ x-enum-varnames:
2193
+ - RUNBOOK
2194
+ AlertEventCustomAttributesPriority:
2195
+ description: The priority of the alert.
2196
+ enum:
2197
+ - '1'
2198
+ - '2'
2199
+ - '3'
2200
+ - '4'
2201
+ - '5'
2202
+ example: '1'
2203
+ type: string
2204
+ x-enum-varnames:
2205
+ - PRIORITY_ONE
2206
+ - PRIORITY_TWO
2207
+ - PRIORITY_THREE
2208
+ - PRIORITY_FOUR
2209
+ - PRIORITY_FIVE
2210
+ AlertEventCustomAttributesStatus:
2211
+ description: The status of the alert.
2212
+ enum:
2213
+ - info
2214
+ - warn
2215
+ - error
2216
+ - ok
2217
+ example: warn
2218
+ type: string
2219
+ x-enum-varnames:
2220
+ - INFO
2221
+ - WARN
2222
+ - ERROR
2223
+ - OK
2141
2224
Annotation:
2142
2225
description: A list of annotations used in the workflow. These are like sticky
2143
2226
notes for your workflow!
@@ -13904,28 +13987,34 @@ components:
13904
13987
type: string
13905
13988
type: object
13906
13989
EventCategory:
13907
- description: Event category to identify the type of event. Only the value `change`
13908
- is supported. Support for other categories are coming. please reach out to
13909
- datadog support if you're interested.
13990
+ description: Event category to identify the type of event. For example, `change`
13991
+ or `alert`.
13910
13992
enum:
13911
13993
- change
13994
+ - alert
13912
13995
example: change
13913
13996
type: string
13914
13997
x-enum-varnames:
13915
13998
- CHANGE
13999
+ - ALERT
13916
14000
EventCreateRequest:
13917
14001
description: Object representing an event creation request.
13918
14002
properties:
13919
14003
attributes:
13920
14004
$ref: '#/components/schemas/EventPayload'
13921
14005
type:
13922
14006
$ref: '#/components/schemas/EventCreateRequestType'
14007
+ required:
14008
+ - type
14009
+ - attributes
13923
14010
type: object
13924
14011
EventCreateRequestPayload:
13925
14012
description: Payload for creating an event.
13926
14013
properties:
13927
14014
data:
13928
14015
$ref: '#/components/schemas/EventCreateRequest'
14016
+ required:
14017
+ - data
13929
14018
type: object
13930
14019
EventCreateRequestType:
13931
14020
description: Entity type.
@@ -13940,6 +14029,12 @@ components:
13940
14029
properties:
13941
14030
attributes:
13942
14031
$ref: '#/components/schemas/EventCreateResponseAttributes'
14032
+ id:
14033
+ description: A numerical ID compatible with the V1 endpoint. This field
14034
+ is not populated in response from the V2 endpoint. To retrieve this ID,
14035
+ refer to the event attributes in the Event Explorer.
14036
+ example: _
14037
+ type: string
13943
14038
type:
13944
14039
description: Event type
13945
14040
example: event
@@ -13961,28 +14056,44 @@ components:
13961
14056
EventCreateResponseAttributesAttributesEvt:
13962
14057
description: JSON object of event system attributes.
13963
14058
properties:
13964
- id:
13965
- description: Event id
14059
+ uid:
14060
+ description: A unique identifier for the event. You can use this ID to query
14061
+ or reference the event in the V2 endpoint.
14062
+ example: ABCDEFGHIJKLMNOPQRSTUVWX
13966
14063
type: string
13967
14064
type: object
13968
14065
EventCreateResponsePayload:
13969
14066
description: Response containing information about created event.
13970
14067
properties:
13971
14068
data:
13972
14069
$ref: '#/components/schemas/EventCreateResponse'
14070
+ links:
14071
+ $ref: '#/components/schemas/EventCreateResponsePayloadLinks'
14072
+ type: object
14073
+ EventCreateResponsePayloadLinks:
14074
+ description: Links attributes.
14075
+ properties:
14076
+ self:
14077
+ description: The URL of the event. This link is only functional when using
14078
+ the `app` subdomain.
14079
+ example: https://app.datadoghq.com/event/event?uid=ABCDEFGHIJKLMNOPQRSTUVWX
14080
+ type: string
13973
14081
type: object
13974
14082
EventPayload:
13975
14083
description: Event attributes.
13976
14084
properties:
13977
14085
aggregation_key:
13978
14086
description: An arbitrary string to use for aggregation when correlating
13979
14087
events. Limited to 100 characters.
14088
+ example: aggregation_key_123
13980
14089
maxLength: 100
13981
14090
type: string
13982
14091
attributes:
13983
14092
$ref: '#/components/schemas/EventPayloadAttributes'
13984
14093
category:
13985
14094
$ref: '#/components/schemas/EventCategory'
14095
+ integration_id:
14096
+ $ref: '#/components/schemas/EventPayloadIntegrationId'
13986
14097
message:
13987
14098
description: The body of the event. Limited to 4000 characters.
13988
14099
example: payment_processed feature flag has been enabled
@@ -13996,7 +14107,10 @@ components:
13996
14107
- env:test
13997
14108
items:
13998
14109
description: A tag.
14110
+ maxLength: 200
13999
14111
type: string
14112
+ maxItems: 100
14113
+ minItems: 1
14000
14114
type: array
14001
14115
timestamp:
14002
14116
description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
@@ -14022,6 +14136,16 @@ components:
14022
14136
event category.
14023
14137
oneOf:
14024
14138
- $ref: '#/components/schemas/ChangeEventCustomAttributes'
14139
+ - $ref: '#/components/schemas/AlertEventCustomAttributes'
14140
+ EventPayloadIntegrationId:
14141
+ description: Integration IDs sourced from integration manifests. Currently,
14142
+ only `custom-events` is supported.
14143
+ enum:
14144
+ - custom-events
14145
+ example: custom-events
14146
+ type: string
14147
+ x-enum-varnames:
14148
+ - CUSTOM_EVENTS
14025
14149
EventPriority:
14026
14150
description: The priority of the event's monitor. For example, `normal` or `low`.
14027
14151
enum:
@@ -45640,7 +45764,8 @@ paths:
45640
45764
- events_read
45641
45765
post:
45642
45766
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
45643
- with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
45767
+ with the `change` or `alert` category** are in General Availability. For change
45768
+ events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
45644
45769
for more details.\n\n\u274C For use cases involving other event categories,
45645
45770
please use the V1 endpoint."
45646
45771
operationId: CreateEvent
@@ -45652,6 +45777,7 @@ paths:
45652
45777
value:
45653
45778
data:
45654
45779
attributes:
45780
+ aggregation_key: aggregation_key_123
45655
45781
attributes:
45656
45782
author:
45657
45783
@@ -45680,6 +45806,7 @@ paths:
45680
45806
rule:
45681
45807
datacenter: devcycle.us1.prod
45682
45808
category: change
45809
+ integration_id: custom-events
45683
45810
message: payment_processed feature flag has been enabled
45684
45811
tags:
45685
45812
- env:test
@@ -45690,7 +45817,7 @@ paths:
45690
45817
description: Event request object
45691
45818
required: true
45692
45819
responses:
45693
- '200 ':
45820
+ '202 ':
45694
45821
content:
45695
45822
application/json:
45696
45823
schema:
@@ -45713,6 +45840,38 @@ paths:
45713
45840
security:
45714
45841
- apiKeyAuth: []
45715
45842
appKeyAuth: []
45843
+ servers:
45844
+ - url: https://{subdomain}.{site}
45845
+ variables:
45846
+ site:
45847
+ default: datadoghq.com
45848
+ description: The regional site for customers.
45849
+ enum:
45850
+ - datadoghq.com
45851
+ - us3.datadoghq.com
45852
+ - us5.datadoghq.com
45853
+ - ap1.datadoghq.com
45854
+ - datadoghq.eu
45855
+ - ddog-gov.com
45856
+ subdomain:
45857
+ default: event-management-intake
45858
+ description: The subdomain where the API is deployed.
45859
+ - url: '{protocol}://{name}'
45860
+ variables:
45861
+ name:
45862
+ default: event-management-intake.datadoghq.com
45863
+ description: Full site DNS name.
45864
+ protocol:
45865
+ default: https
45866
+ description: The protocol for accessing the API.
45867
+ - url: https://{subdomain}.{site}
45868
+ variables:
45869
+ site:
45870
+ default: datadoghq.com
45871
+ description: Any Datadog deployment.
45872
+ subdomain:
45873
+ default: event-management-intake
45874
+ description: The subdomain where the API is deployed.
45716
45875
summary: Post an event
45717
45876
tags:
45718
45877
- Events
0 commit comments