Create Alert
curl --request POST \
--url https://api.getmaxim.ai/v1/alerts \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"entityId": "<string>",
"config": {
"metric": "<string>",
"minimumThreshold": 2,
"duration": 123,
"operator": "<string>",
"value": "<string>",
"renotifyTTL": -1
},
"enabled": true,
"notificationChannelIds": [
"<string>"
]
}
'import requests
url = "https://api.getmaxim.ai/v1/alerts"
payload = {
"workspaceId": "<string>",
"entityId": "<string>",
"config": {
"metric": "<string>",
"minimumThreshold": 2,
"duration": 123,
"operator": "<string>",
"value": "<string>",
"renotifyTTL": -1
},
"enabled": True,
"notificationChannelIds": ["<string>"]
}
headers = {
"x-maxim-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: '<string>',
entityId: '<string>',
config: {
metric: '<string>',
minimumThreshold: 2,
duration: 123,
operator: '<string>',
value: '<string>',
renotifyTTL: -1
},
enabled: true,
notificationChannelIds: ['<string>']
})
};
fetch('https://api.getmaxim.ai/v1/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmaxim.ai/v1/alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workspaceId' => '<string>',
'entityId' => '<string>',
'config' => [
'metric' => '<string>',
'minimumThreshold' => 2,
'duration' => 123,
'operator' => '<string>',
'value' => '<string>',
'renotifyTTL' => -1
],
'enabled' => true,
'notificationChannelIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-maxim-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getmaxim.ai/v1/alerts"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"entityId\": \"<string>\",\n \"config\": {\n \"metric\": \"<string>\",\n \"minimumThreshold\": 2,\n \"duration\": 123,\n \"operator\": \"<string>\",\n \"value\": \"<string>\",\n \"renotifyTTL\": -1\n },\n \"enabled\": true,\n \"notificationChannelIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-maxim-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getmaxim.ai/v1/alerts")
.header("x-maxim-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"entityId\": \"<string>\",\n \"config\": {\n \"metric\": \"<string>\",\n \"minimumThreshold\": 2,\n \"duration\": 123,\n \"operator\": \"<string>\",\n \"value\": \"<string>\",\n \"renotifyTTL\": -1\n },\n \"enabled\": true,\n \"notificationChannelIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmaxim.ai/v1/alerts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"entityId\": \"<string>\",\n \"config\": {\n \"metric\": \"<string>\",\n \"minimumThreshold\": 2,\n \"duration\": 123,\n \"operator\": \"<string>\",\n \"value\": \"<string>\",\n \"renotifyTTL\": -1\n },\n \"enabled\": true,\n \"notificationChannelIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspaceId": "<string>",
"entityId": "<string>",
"type": "<string>",
"enabled": true,
"config": {
"metric": "<string>",
"minimumThreshold": 2,
"duration": 123,
"operator": "<string>",
"value": "<string>",
"renotifyTTL": -1
},
"createdAt": "<string>",
"updatedAt": "<string>",
"notificationChannels": [
{
"notificationChannel": {
"id": "<string>",
"name": "<string>",
"config": {}
}
}
]
}Alert
Create Alert
Create a new alert
POST
/
v1
/
alerts
Create Alert
curl --request POST \
--url https://api.getmaxim.ai/v1/alerts \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"entityId": "<string>",
"config": {
"metric": "<string>",
"minimumThreshold": 2,
"duration": 123,
"operator": "<string>",
"value": "<string>",
"renotifyTTL": -1
},
"enabled": true,
"notificationChannelIds": [
"<string>"
]
}
'import requests
url = "https://api.getmaxim.ai/v1/alerts"
payload = {
"workspaceId": "<string>",
"entityId": "<string>",
"config": {
"metric": "<string>",
"minimumThreshold": 2,
"duration": 123,
"operator": "<string>",
"value": "<string>",
"renotifyTTL": -1
},
"enabled": True,
"notificationChannelIds": ["<string>"]
}
headers = {
"x-maxim-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: '<string>',
entityId: '<string>',
config: {
metric: '<string>',
minimumThreshold: 2,
duration: 123,
operator: '<string>',
value: '<string>',
renotifyTTL: -1
},
enabled: true,
notificationChannelIds: ['<string>']
})
};
fetch('https://api.getmaxim.ai/v1/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmaxim.ai/v1/alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workspaceId' => '<string>',
'entityId' => '<string>',
'config' => [
'metric' => '<string>',
'minimumThreshold' => 2,
'duration' => 123,
'operator' => '<string>',
'value' => '<string>',
'renotifyTTL' => -1
],
'enabled' => true,
'notificationChannelIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-maxim-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getmaxim.ai/v1/alerts"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"entityId\": \"<string>\",\n \"config\": {\n \"metric\": \"<string>\",\n \"minimumThreshold\": 2,\n \"duration\": 123,\n \"operator\": \"<string>\",\n \"value\": \"<string>\",\n \"renotifyTTL\": -1\n },\n \"enabled\": true,\n \"notificationChannelIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-maxim-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getmaxim.ai/v1/alerts")
.header("x-maxim-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"entityId\": \"<string>\",\n \"config\": {\n \"metric\": \"<string>\",\n \"minimumThreshold\": 2,\n \"duration\": 123,\n \"operator\": \"<string>\",\n \"value\": \"<string>\",\n \"renotifyTTL\": -1\n },\n \"enabled\": true,\n \"notificationChannelIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmaxim.ai/v1/alerts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"entityId\": \"<string>\",\n \"config\": {\n \"metric\": \"<string>\",\n \"minimumThreshold\": 2,\n \"duration\": 123,\n \"operator\": \"<string>\",\n \"value\": \"<string>\",\n \"renotifyTTL\": -1\n },\n \"enabled\": true,\n \"notificationChannelIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspaceId": "<string>",
"entityId": "<string>",
"type": "<string>",
"enabled": true,
"config": {
"metric": "<string>",
"minimumThreshold": 2,
"duration": 123,
"operator": "<string>",
"value": "<string>",
"renotifyTTL": -1
},
"createdAt": "<string>",
"updatedAt": "<string>",
"notificationChannels": [
{
"notificationChannel": {
"id": "<string>",
"name": "<string>",
"config": {}
}
}
]
}Authorizations
API key for authentication
Body
application/json
Unique identifier for the workspace
ID of the entity to create alert for
Type of entity for the alert
Available options:
WORKFLOW, WORKFLOW_SIMULATION, PROMPT_CHAIN, DATASET, DATASET_SPLIT, PROMPT, DATASOURCE, PROMPT_EXPERIMENT, LOG_REPOSITORY, PROMPT_TOOL, EVALUATOR, SDK, TEST_RUN, RUN_REPORT Show child attributes
Show child attributes
Whether the alert is enabled
List of notification channel IDs eg: ["channel_123", "channel_456"]
Was this page helpful?
⌘I