8000 Update events intake specs for v2 events post endpoint by api-clients-generation-pipeline[bot] · Pull Request #29118 · DataDog/documentation · GitHub
[go: up one dir, main page]

Skip to content
8000

Update events intake specs for v2 events post endpoint #29118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-05-20 07:23:31.781659",
"spec_repo_commit": "fec20f97"
"regenerated": "2025-05-21 13:42:06.023664",
"spec_repo_commit": "0bddf9bc"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-05-20 07:23:40.945974",
"spec_repo_commit": "fec20f97"
"regenerated": "2025-05-21 13:42:15.687527",
"spec_repo_commit": "0bddf9bc"
}
}
}
19 changes: 12 additions & 7 deletions content/en/api/v2/events/examples.json

Large diffs are not rendered by default.

182 changes: 169 additions & 13 deletions data/api/v2/full_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2203,6 +2203,89 @@ components:
- id
- base_severity
type: object
AlertEventCustomAttributes:
additionalProperties: false
description: Object representing custom alert event attributes.
properties:
custom:
$ref: '#/components/schemas/AlertEventCustomAttributesCustom'
links:
$ref: '#/components/schemas/AlertEventCustomAttributesLinks'
priority:
$ref: '#/components/schemas/AlertEventCustomAttributesPriority'
status:
$ref: '#/components/schemas/AlertEventCustomAttributesStatus'
type: object
AlertEventCustomAttributesCustom:
additionalProperties: {}
description: Custom attributes. Support up to 100 properties and a maximum nesting
depth of 10 levels.
example: {}
type: object
AlertEventCustomAttributesLinks:
description: The links related to the event.
items:
$ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
maxItems: 20
minItems: 1
type: array
AlertEventCustomAttributesLinksItems:
description: A link.
properties:
category:
$ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
title:
description: The title of the link. Limited to 300 characters.
example: Runbook Link
maxLength: 300
type: string
url:
description: The URL of the link. Limited to 2048 characters.
example: https://app.datadoghq.com/runbook
maxLength: 2048
type: string
required:
- url
- category
type: object
AlertEventCustomAttributesLinksItemsCategory:
description: The category of the link.
enum:
- runbook
example: runbook
type: string
x-enum-varnames:
- RUNBOOK
AlertEventCustomAttributesPriority:
description: The priority of the alert.
enum:
- '1'
- '2'
- '3'
- '4'
- '5'
example: '1'
type: string
x-enum-varnames:
- PRIORITY_ONE
- PRIORITY_TWO
- PRIORITY_THREE
- PRIORITY_FOUR
- PRIORITY_FIVE
AlertEventCustomAttributesStatus:
description: The status of the alert.
enum:
- info
- warn
- error
- ok
example: warn
type: string
x-enum-varnames:
- INFO
- WARN
- ERROR
- OK
Annotation:
description: A list of annotations used in the workflow. These are like sticky
notes for your workflow!
Expand Down Expand Up @@ -6923,6 +7006,7 @@ components:
type: integer
type: object
ChangeEventCustomAttributes:
additionalProperties: false
description: Object representing custom change event attributes.
properties:
author:
Expand Down Expand Up @@ -6975,8 +7059,8 @@ components:
- changed_resource
type: object
ChangeEventCustomAttributesAuthor:
description: Object representing the entity which made the change. Optional
field but if provided should include `type` and `name`.
description: Object representing the entity that made the change. Optional field
but if provided should include type and name.
properties:
name:
description: Author's name. Limited to 128 characters.
Expand Down Expand Up @@ -14109,28 +14193,33 @@ components:
type: string
type: object
EventCategory:
description: Event category to identify the type of event. Only the value `change`
is supported. Support for other categories are coming. please reach out to
datadog support if you're interested.
description: Event category to identify the type of event.
enum:
- change
- alert
example: change
type: string
x-enum-varnames:
- CHANGE
- ALERT
EventCreateRequest:
description: Object representing an event creation request.
properties:
attributes:
$ref: '#/components/schemas/EventPayload'
type:
$ref: '#/components/schemas/EventCreateRequestType'
required:
- type
- attributes
type: object
EventCreateRequestPayload:
description: Payload for creating an event.
properties:
data:
$ref: '#/components/schemas/EventCreateRequest'
required:
- data
type: object
EventCreateRequestType:
description: Entity type.
Expand Down Expand Up @@ -14166,28 +14255,43 @@ components:
EventCreateResponseAttributesAttributesEvt:
description: JSON object of event system attributes.
properties:
id:
description: Event id
uid:
description: A unique identifier for the event. You can use this ID to query
or reference the event in the V2 endpoint.
type: string
type: object
EventCreateResponsePayload:
description: Response containing information about created event.
properties:
data:
$ref: '#/components/schemas/EventCreateResponse'
links:
$ref: '#/components/schemas/EventCreateResponsePayloadLinks'
type: object
EventCreateResponsePayloadLinks:
description: Links attributes.
properties:
self:
description: The URL of the event. This link is only functional when using
the default subdomain.
type: string
type: object
EventPayload:
description: Event attributes.
properties:
aggregation_key:
description: An arbitrary string to use for aggregation when correlating
events. Limited to 100 characters.
events. If you specify a key, events are deduplicated to alerts based
on this key. Limited to 100 characters.
example: aggregation_key_123
maxLength: 100
type: string
attributes:
$ref: '#/components/schemas/EventPayloadAttributes'
category:
$ref: '#/components/schemas/EventCategory'
integration_id:
$ref: '#/components/schemas/EventPayloadIntegrationId'
message:
description: The body of the event. Limited to 4000 characters.
example: payment_processed feature flag has been enabled
Expand All @@ -14201,7 +14305,10 @@ components:
- env:test
items:
description: A tag.
maxLength: 200
type: string
maxItems: 100
minItems: 1
type: array
timestamp:
description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
Expand All @@ -14211,6 +14318,7 @@ components:

Defaults to the timestamp of receipt. Limited to values no older than
18 hours.'
example: '2020-01-01T01:30:15.010000Z'
type: string
title:
description: The event title. Limited to 500 characters.
Expand All @@ -14223,10 +14331,20 @@ components:
- attributes
type: object
EventPayloadAttributes:
description: JSON object for custom attributes. Schema are different per each
event category.
description: JSON object for custom attributes. Schema is different per event
category.
oneOf:
- $ref: '#/components/schemas/ChangeEventCustomAttributes'
- $ref: '#/components/schemas/AlertEventCustomAttributes'
EventPayloadIntegrationId:
description: Integration IDs sourced from integration manifests. Currently,
only `custom-events` is supported.
enum:
- custom-events
example: custom-events
type: string
x-enum-varnames:
- CUSTOM_EVENTS
EventPriority:
description: The priority of the event's monitor. For example, `normal` or `low`.
enum:
Expand Down Expand Up @@ -47040,9 +47158,12 @@ paths:
type: safe
post:
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
with the `change` or `alert` category** are in General Availability. For change
events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
for more details.\n\n\u274C For use cases involving other event categories,
please use the V1 endpoint."
please use the V1 endpoint.\n\u274C Currently, notifications are not supported
for events sent to this endpoint, please use the V1 endpoint for notification
functionality."
operationId: CreateEvent
requestBody:
content:
Expand All @@ -47052,6 +47173,7 @@ paths:
value:
data:
attributes:
aggregation_key: aggregation_key_123
attributes:
author:
name: datadog@datadog.com
Expand Down Expand Up @@ -47080,17 +47202,19 @@ paths:
rule:
datacenter: devcycle.us1.prod
category: change
integration_id: custom-events
message: payment_processed feature flag has been enabled
tags:
- env:test
timestamp: '2020-01-01T01:30:15.010000Z'
title: payment_processed feature flag updated
type: event
schema:
$ref: '#/components/schemas/EventCreateRequestPayload'
description: Event request object
required: true
responses:
'200':
'202':
content:
application/json:
schema:
Expand All @@ -47113,6 +47237,38 @@ paths:
security:
- apiKeyAuth: []
appKeyAuth: []
servers:
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: The regional site for customers.
enum:
- datadoghq.com
- us3.datadoghq.com
- us5.datadoghq.com
- ap1.datadoghq.com
- datadoghq.eu
- ddog-gov.com
subdomain:
default: event-management-intake
description: The subdomain where the API is deployed.
- url: '{protocol}://{name}'
variables:
name:
default: event-management-intake.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: event-management-intake
description: The subdomain where the API is deployed.
summary: Post an event
tags:
- Events
Expand Down
Loading
Loading
0