Skip to content

Commit 6644855

Browse files
Adds POST event v2 alert example (#30899)
* Adds POST event v2 alert example * Modify example description * Add CURL examples * Revert curl examples
1 parent e95676a commit 6644855

File tree

3 files changed

+82
-40
lines changed

3 files changed

+82
-40
lines changed
Lines changed: 21 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,37 @@
11
{
22
"data": {
3+
"type": "event",
34
"attributes": {
45
"aggregation_key": "aggregation_key_123",
56
"attributes": {
6-
"author": {
7-
"name": "[email protected]",
8-
"type": "user"
7+
"custom": {
8+
"threshold": 95,
9+
"current_value": 98,
10+
"metric": "cpu.utilization"
911
},
10-
"change_metadata": {
11-
"dd": {
12-
"team": "datadog_team",
13-
"user_email": "[email protected]",
14-
"user_id": "datadog_user_id",
15-
"user_name": "datadog_username"
12+
"links": [
13+
{
14+
"category": "runbook",
15+
"title": "CPU Alert Runbook",
16+
"url": "https://example.com/runbooks/cpu-alert"
1617
},
17-
"resource_link": "datadog.com/feature/fallback_payments_test"
18-
},
19-
"changed_resource": {
20-
"name": "fallback_payments_test",
21-
"type": "feature_flag"
22-
},
23-
"impacted_resources": [
2418
{
25-
"name": "payments_api",
26-
"type": "service"
19+
"category": "dashboard",
20+
"url": "https://example.com/dashboards/cpu-usage"
2721
}
2822
],
29-
"new_value": {
30-
"enabled": true,
31-
"percentage": "50%",
32-
"rule": {
33-
"datacenter": "devcycle.us1.prod"
34-
}
35-
},
36-
"prev_value": {
37-
"enabled": true,
38-
"percentage": "10%",
39-
"rule": {
40-
"datacenter": "devcycle.us1.prod"
41-
}
42-
}
23+
"priority": "2",
24+
"status": "error"
4325
},
44-
"category": "change",
26+
"category": "alert",
4527
"integration_id": "custom-events",
46-
"message": "payment_processed feature flag has been enabled",
28+
"message": "CPU usage exceeded the 95% threshold for more than 5 minutes.",
4729
"tags": [
48-
"env:api_client_test"
30+
"env:production",
31+
"team:infrastructure"
4932
],
50-
"title": "payment_processed feature flag updated"
51-
},
52-
"type": "event"
33+
"timestamp": "2025-08-05T10:30:00Z",
34+
"title": "High CPU usage on production nodes"
35+
}
5336
}
5437
}
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{
2+
"data": {
3+
"attributes": {
4+
"aggregation_key": "aggregation_key_123",
5+
"attributes": {
6+
"author": {
7+
"name": "[email protected]",
8+
"type": "user"
9+
},
10+
"change_metadata": {
11+
"dd": {
12+
"team": "datadog_team",
13+
"user_email": "[email protected]",
14+
"user_id": "datadog_user_id",
15+
"user_name": "datadog_username"
16+
},
17+
"resource_link": "datadog.com/feature/fallback_payments_test"
18+
},
19+
"changed_resource": {
20+
"name": "fallback_payments_test",
21+
"type": "feature_flag"
22+
},
23+
"impacted_resources": [
24+
{
25+
"name": "payments_api",
26+
"type": "service"
27+
}
28+
],
29+
"new_value": {
30+
"enabled": true,
31+
"percentage": "50%",
32+
"rule": {
33+
"datacenter": "devcycle.us1.prod"
34+
}
35+
},
36+
"prev_value": {
37+
"enabled": true,
38+
"percentage": "10%",
39+
"rule": {
40+
"datacenter": "devcycle.us1.prod"
41+
}
42+
}
43+
},
44+
"category": "change",
45+
"integration_id": "custom-events",
46+
"message": "payment_processed feature flag has been enabled",
47+
"tags": [
48+
"env:api_client_test"
49+
],
50+
"title": "payment_processed feature flag updated"
51+
},
52+
"type": "event"
53+
}
54+
}

data/api/v2/CodeExamples.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,12 @@
464464
{
465465
"group": "events",
466466
"suffix": "",
467-
"description": "Post an event returns \"OK\" response"
467+
"description": "Example"
468+
},
469+
{
470+
"group": "events",
471+
"suffix": "_change",
472+
"description": "Example 2"
468473
}
469474
],
470475
"SearchEvents": [
@@ -1599,4 +1604,4 @@
15991604
"description": "Update an existing Workflow returns \"Successfully updated a workflow.\" response"
16001605
}
16011606
]
1602-
}
1607+
}

0 commit comments

Comments
 (0)