Notifications
Create a notification destination
Org owners and admins only. Slack destinations need a Slack workspace connected to the organization and a channel from the Slack channel list; the CostGraph app must be in a private channel to post there. Webhook and Teams destinations need an https URL; Teams URLs must be Power Automate workflow URLs. PagerDuty destinations need an Events API v2 integration key. A webhook’s signing secret is returned once, here, and never again. A route with a tag filter must name a tenant.
POST
/
api
/
v1
/
organizations
/
{org_id}
/
notifications
/
destinations
Create a notification destination
curl --request POST \
--url https://api.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"member_ids": [
"<string>"
],
"roles": [
"<string>"
],
"routes": [
{
"kind_pattern": "<string>",
"min_cost_impact": 123,
"min_severity": "<string>",
"tag_key": "<string>",
"tag_value": "<string>",
"tenant_id": "<string>"
}
],
"routing_key": "<string>",
"slack_channel_id": "<string>",
"slack_channel_name": "<string>",
"slack_installation_id": "<string>",
"url": "<string>"
}
'import requests
url = "https://api.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations"
payload = {
"name": "<string>",
"member_ids": ["<string>"],
"roles": ["<string>"],
"routes": [
{
"kind_pattern": "<string>",
"min_cost_impact": 123,
"min_severity": "<string>",
"tag_key": "<string>",
"tag_value": "<string>",
"tenant_id": "<string>"
}
],
"routing_key": "<string>",
"slack_channel_id": "<string>",
"slack_channel_name": "<string>",
"slack_installation_id": "<string>",
"url": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
member_ids: ['<string>'],
roles: ['<string>'],
routes: [
{
kind_pattern: '<string>',
min_cost_impact: 123,
min_severity: '<string>',
tag_key: '<string>',
tag_value: '<string>',
tenant_id: '<string>'
}
],
routing_key: '<string>',
slack_channel_id: '<string>',
slack_channel_name: '<string>',
slack_installation_id: '<string>',
url: '<string>'
})
};
fetch('https://api.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations', 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.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations",
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([
'name' => '<string>',
'member_ids' => [
'<string>'
],
'roles' => [
'<string>'
],
'routes' => [
[
'kind_pattern' => '<string>',
'min_cost_impact' => 123,
'min_severity' => '<string>',
'tag_key' => '<string>',
'tag_value' => '<string>',
'tenant_id' => '<string>'
]
],
'routing_key' => '<string>',
'slack_channel_id' => '<string>',
'slack_channel_name' => '<string>',
'slack_installation_id' => '<string>',
'url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"routes\": [\n {\n \"kind_pattern\": \"<string>\",\n \"min_cost_impact\": 123,\n \"min_severity\": \"<string>\",\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\",\n \"tenant_id\": \"<string>\"\n }\n ],\n \"routing_key\": \"<string>\",\n \"slack_channel_id\": \"<string>\",\n \"slack_channel_name\": \"<string>\",\n \"slack_installation_id\": \"<string>\",\n \"url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"routes\": [\n {\n \"kind_pattern\": \"<string>\",\n \"min_cost_impact\": 123,\n \"min_severity\": \"<string>\",\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\",\n \"tenant_id\": \"<string>\"\n }\n ],\n \"routing_key\": \"<string>\",\n \"slack_channel_id\": \"<string>\",\n \"slack_channel_name\": \"<string>\",\n \"slack_installation_id\": \"<string>\",\n \"url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"routes\": [\n {\n \"kind_pattern\": \"<string>\",\n \"min_cost_impact\": 123,\n \"min_severity\": \"<string>\",\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\",\n \"tenant_id\": \"<string>\"\n }\n ],\n \"routing_key\": \"<string>\",\n \"slack_channel_id\": \"<string>\",\n \"slack_channel_name\": \"<string>\",\n \"slack_installation_id\": \"<string>\",\n \"url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "some message",
"status": "success",
"data": {
"destination": {
"addresses": [
{
"confirmed": true,
"email": "<string>",
"id": "<string>",
"confirmation_sent_at": "<string>"
}
],
"config": {},
"created_at": "<string>",
"enabled": true,
"health": {
"status": "delivering",
"waiting": 123,
"last_delivered_at": "<string>",
"last_failure_at": "<string>",
"last_failure_reason": "<string>"
},
"id": "<string>",
"kind": "slack",
"member_ids": [
"<string>"
],
"name": "<string>",
"organization_id": "<string>",
"roles": [
"<string>"
],
"routes": [
{
"id": "<string>",
"kind_pattern": "<string>",
"min_cost_impact_currency": "<string>",
"min_cost_impact": 123,
"min_severity": "<string>",
"tag_key": "<string>",
"tag_value": "<string>",
"tenant_id": "<string>"
}
],
"updated_at": "<string>"
},
"signing_secret": "<string>"
}
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}Authorizations
Enter "Bearer {token}"
Path Parameters
Organization ID
Body
application/json
Destination
Available options:
slack, teams, webhook, email_list, pagerduty Maximum string length:
200Maximum array length:
500Maximum array length:
4Maximum array length:
50Show child attributes
Show child attributes
Maximum string length:
64Maximum string length:
32Maximum string length:
80Maximum string length:
2048Was this page helpful?
⌘I
Create a notification destination
curl --request POST \
--url https://api.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"member_ids": [
"<string>"
],
"roles": [
"<string>"
],
"routes": [
{
"kind_pattern": "<string>",
"min_cost_impact": 123,
"min_severity": "<string>",
"tag_key": "<string>",
"tag_value": "<string>",
"tenant_id": "<string>"
}
],
"routing_key": "<string>",
"slack_channel_id": "<string>",
"slack_channel_name": "<string>",
"slack_installation_id": "<string>",
"url": "<string>"
}
'import requests
url = "https://api.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations"
payload = {
"name": "<string>",
"member_ids": ["<string>"],
"roles": ["<string>"],
"routes": [
{
"kind_pattern": "<string>",
"min_cost_impact": 123,
"min_severity": "<string>",
"tag_key": "<string>",
"tag_value": "<string>",
"tenant_id": "<string>"
}
],
"routing_key": "<string>",
"slack_channel_id": "<string>",
"slack_channel_name": "<string>",
"slack_installation_id": "<string>",
"url": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
member_ids: ['<string>'],
roles: ['<string>'],
routes: [
{
kind_pattern: '<string>',
min_cost_impact: 123,
min_severity: '<string>',
tag_key: '<string>',
tag_value: '<string>',
tenant_id: '<string>'
}
],
routing_key: '<string>',
slack_channel_id: '<string>',
slack_channel_name: '<string>',
slack_installation_id: '<string>',
url: '<string>'
})
};
fetch('https://api.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations', 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.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations",
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([
'name' => '<string>',
'member_ids' => [
'<string>'
],
'roles' => [
'<string>'
],
'routes' => [
[
'kind_pattern' => '<string>',
'min_cost_impact' => 123,
'min_severity' => '<string>',
'tag_key' => '<string>',
'tag_value' => '<string>',
'tenant_id' => '<string>'
]
],
'routing_key' => '<string>',
'slack_channel_id' => '<string>',
'slack_channel_name' => '<string>',
'slack_installation_id' => '<string>',
'url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"routes\": [\n {\n \"kind_pattern\": \"<string>\",\n \"min_cost_impact\": 123,\n \"min_severity\": \"<string>\",\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\",\n \"tenant_id\": \"<string>\"\n }\n ],\n \"routing_key\": \"<string>\",\n \"slack_channel_id\": \"<string>\",\n \"slack_channel_name\": \"<string>\",\n \"slack_installation_id\": \"<string>\",\n \"url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"routes\": [\n {\n \"kind_pattern\": \"<string>\",\n \"min_cost_impact\": 123,\n \"min_severity\": \"<string>\",\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\",\n \"tenant_id\": \"<string>\"\n }\n ],\n \"routing_key\": \"<string>\",\n \"slack_channel_id\": \"<string>\",\n \"slack_channel_name\": \"<string>\",\n \"slack_installation_id\": \"<string>\",\n \"url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/organizations/{org_id}/notifications/destinations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"routes\": [\n {\n \"kind_pattern\": \"<string>\",\n \"min_cost_impact\": 123,\n \"min_severity\": \"<string>\",\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\",\n \"tenant_id\": \"<string>\"\n }\n ],\n \"routing_key\": \"<string>\",\n \"slack_channel_id\": \"<string>\",\n \"slack_channel_name\": \"<string>\",\n \"slack_installation_id\": \"<string>\",\n \"url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "some message",
"status": "success",
"data": {
"destination": {
"addresses": [
{
"confirmed": true,
"email": "<string>",
"id": "<string>",
"confirmation_sent_at": "<string>"
}
],
"config": {},
"created_at": "<string>",
"enabled": true,
"health": {
"status": "delivering",
"waiting": 123,
"last_delivered_at": "<string>",
"last_failure_at": "<string>",
"last_failure_reason": "<string>"
},
"id": "<string>",
"kind": "slack",
"member_ids": [
"<string>"
],
"name": "<string>",
"organization_id": "<string>",
"roles": [
"<string>"
],
"routes": [
{
"id": "<string>",
"kind_pattern": "<string>",
"min_cost_impact_currency": "<string>",
"min_cost_impact": 123,
"min_severity": "<string>",
"tag_key": "<string>",
"tag_value": "<string>",
"tenant_id": "<string>"
}
],
"updated_at": "<string>"
},
"signing_secret": "<string>"
}
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}