Skip to content

Update events intake specs for v2 events post endpoint #2546

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-08 14:34:53.291523",
"spec_repo_commit": "4b632dba"
"regenerated": "2025-05-09 01:01:36.764757",
"spec_repo_commit": "9f916c56"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-05-08 14:34:53.311445",
"spec_repo_commit": "4b632dba"
"regenerated": "2025-05-09 01:01:36.781509",
"spec_repo_commit": "9f916c56"
}
}
}
173 changes: 166 additions & 7 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2138,6 +2138,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 @@ -13904,28 +13987,34 @@ 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. For example, `change`
or `alert`.
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 All @@ -13940,6 +14029,12 @@ components:
properties:
attributes:
$ref: '#/components/schemas/EventCreateResponseAttributes'
id:
description: A numerical ID compatible with the V1 endpoint. This field
is not populated in response from the V2 endpoint. To retrieve this ID,
refer to the event attributes in the Event Explorer.
example: _
type: string
type:
description: Event type
example: event
Expand All @@ -13961,28 +14056,44 @@ 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.
example: ABCDEFGHIJKLMNOPQRSTUVWX
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 `app` subdomain.
example: https://app.datadoghq.com/event/event?uid=ABCDEFGHIJKLMNOPQRSTUVWX
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.
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 @@ -13996,7 +14107,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 @@ -14022,6 +14136,16 @@ components:
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 @@ -45640,7 +45764,8 @@ paths:
- events_read
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."
operationId: CreateEvent
Expand All @@ -45652,6 +45777,7 @@ paths:
value:
data:
attributes:
aggregation_key: aggregation_key_123
attributes:
author:
name: [email protected]
Expand Down Expand Up @@ -45680,6 +45806,7 @@ paths:
rule:
datacenter: devcycle.us1.prod
category: change
integration_id: custom-events
message: payment_processed feature flag has been enabled
tags:
- env:test
Expand All @@ -45690,7 +45817,7 @@ paths:
description: Event request object
required: true
responses:
'200':
'202':
content:
application/json:
schema:
Expand All @@ -45713,6 +45840,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
56 changes: 56 additions & 0 deletions docs/datadog_api_client.v2.model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,48 @@ datadog\_api\_client.v2.model.advisory module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.alert\_event\_custom\_attributes module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.alert\_event\_custom\_attributes\_custom module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes_custom
:members:
:show-inheritance:

datadog\_api\_client.v2.model.alert\_event\_custom\_attributes\_links\_items module
-----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes_links_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.alert\_event\_custom\_attributes\_links\_items\_category module
---------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes_links_items_category
:members:
:show-inheritance:

datadog\_api\_client.v2.model.alert\_event\_custom\_attributes\_priority module
-------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes_priority
:members:
:show-inheritance:

datadog\_api\_client.v2.model.alert\_event\_custom\_attributes\_status module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes_status
:members:
:show-inheritance:

datadog\_api\_client.v2.model.annotation module
-----------------------------------------------

Expand Down Expand Up @@ -5723,6 +5765,13 @@ datadog\_api\_client.v2.model.event\_create\_response\_payload module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.event\_create\_response\_payload\_links module
----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.event_create_response_payload_links
:members:
:show-inheritance:

datadog\_api\_client.v2.model.event\_payload module
---------------------------------------------------

Expand All @@ -5737,6 +5786,13 @@ datadog\_api\_client.v2.model.event\_payload\_attributes module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.event\_payload\_integration\_id module
--------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.event_payload_integration_id
:members:
:show-inheritance:

datadog\_api\_client.v2.model.event\_priority module
----------------------------------------------------

Expand Down
Loading