Skip to main content
POST
/
api
/
v2
/
alerts
Create Alert
curl --request POST \
  --url https://api.hyperdx.io/api/v2/alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dashboardId": "65f5e4a3b9e77c001a567890",
  "tileId": "65f5e4a3b9e77c001a901234",
  "threshold": 100,
  "interval": "1h",
  "source": "tile",
  "thresholdType": "above",
  "channel": {
    "type": "webhook",
    "webhookId": "65f5e4a3b9e77c001a789012"
  },
  "name": "Error Spike Alert",
  "message": "Error rate has exceeded 100 in the last hour"
}
'
{
  "data": {
    "id": "65f5e4a3b9e77c001a123456",
    "name": "High Error Rate",
    "message": "Error rate exceeds threshold",
    "threshold": 100,
    "interval": "15m",
    "thresholdType": "above",
    "source": "tile",
    "state": "inactive",
    "channel": {
      "type": "webhook",
      "webhookId": "65f5e4a3b9e77c001a789012"
    },
    "team": "65f5e4a3b9e77c001a345678",
    "tileId": "65f5e4a3b9e77c001a901234",
    "dashboard": "65f5e4a3b9e77c001a567890",
    "savedSearch": "<string>",
    "groupBy": "<string>",
    "silenced": true,
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
threshold
number
required
Example:

100

​
interval
string
required
Example:

"1h"

​
source
enum<string>
required
Available options:
tile,
search
Example:

"tile"

​
thresholdType
enum<string>
required
Available options:
above,
below
Example:

"above"

​
channel
object
required
​
dashboardId
string
Example:

"65f5e4a3b9e77c001a567890"

​
tileId
string
Example:

"65f5e4a3b9e77c001a901234"

​
name
string
Example:

"Test Alert"

​
message
string
Example:

"Test Alert Message"

Response

Successfully created alert

​
data
object