Get webhook payload examples

GET

/v1/private/alerts/webhooks/examples

GET

/api/v1/private/alerts/webhooks/examples

1 curl http://localhost:5173/api/v1/private/alerts/webhooks/examples \
2      -H "Content-Type: application/json"

200Retrieved

1 {
2   "response_examples": {
3     "general": {
4       "alert_id": "alert_1234567890abcdef",
5       "alert_type": "general",
6       "timestamp": "2024-06-01T12:00:00Z",
7       "message": "CPU usage exceeded threshold",
8       "severity": "warning",
9       "details": {
10         "cpu_usage_percent": 92.5,
11         "threshold_percent": 90,
12         "host": "server-01.example.com"
13       }
14     },
15     "slack": {
16       "alert_id": "alert_abcdef1234567890",
17       "alert_type": "slack",
18       "timestamp": "2024-06-01T12:05:00Z",
19       "message": "New message in #alerts channel",
20       "slack_channel": "#alerts",
21       "user": "ops_team",
22       "text": "High memory usage detected on server-02",
23       "severity": "critical"
24     },
25     "pagerduty": {
26       "alert_id": "alert_0987654321fedcba",
27       "alert_type": "pagerduty",
28       "timestamp": "2024-06-01T12:10:00Z",
29       "incident_key": "incident_20240601_001",
30       "service": "database-cluster",
31       "severity": "error",
32       "description": "Database connection timeout",
33       "status": "triggered",
34       "assigned_to": "db_admin"
35     }
36   }
37 }

Get webhook payload examples for all alert event types, optionally filtered by alert type

Query parameters

alert_typeenumOptional

Allowed values:

Response

Webhook examples

response_examplesmap from strings to objects or null