Create a scheduled notification
curl --request POST \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dashboardId": 123,
"customCron": "<string>",
"dayOfMonth": 123,
"dayOfWeek": 123,
"hour": 123,
"minute": 123,
"notificationEnabled": true,
"timezone": "<string>"
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications"
payload = {
"dashboardId": 123,
"customCron": "<string>",
"dayOfMonth": 123,
"dayOfWeek": 123,
"hour": 123,
"minute": 123,
"notificationEnabled": True,
"timezone": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dashboardId: 123,
customCron: '<string>',
dayOfMonth: 123,
dayOfWeek: 123,
hour: 123,
minute: 123,
notificationEnabled: true,
timezone: '<string>'
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications', 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://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications",
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([
'dashboardId' => 123,
'customCron' => '<string>',
'dayOfMonth' => 123,
'dayOfWeek' => 123,
'hour' => 123,
'minute' => 123,
'notificationEnabled' => true,
'timezone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications"
payload := strings.NewReader("{\n \"dashboardId\": 123,\n \"customCron\": \"<string>\",\n \"dayOfMonth\": 123,\n \"dayOfWeek\": 123,\n \"hour\": 123,\n \"minute\": 123,\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dashboardId\": 123,\n \"customCron\": \"<string>\",\n \"dayOfMonth\": 123,\n \"dayOfWeek\": 123,\n \"hour\": 123,\n \"minute\": 123,\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dashboardId\": 123,\n \"customCron\": \"<string>\",\n \"dayOfMonth\": 123,\n \"dayOfWeek\": 123,\n \"hour\": 123,\n \"minute\": 123,\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"cronExpression": "<string>",
"dashboardId": 123,
"deploymentId": 123,
"humanReadableSchedule": "<string>",
"id": 123,
"isEnabled": true,
"notificationEnabled": true,
"notificationFormat": "<string>",
"timezone": "<string>"
}Notifications
Create a scheduled notification
POST
/
v1
/
deployments
/
{deploymentId}
/
notifications
Create a scheduled notification
curl --request POST \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dashboardId": 123,
"customCron": "<string>",
"dayOfMonth": 123,
"dayOfWeek": 123,
"hour": 123,
"minute": 123,
"notificationEnabled": true,
"timezone": "<string>"
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications"
payload = {
"dashboardId": 123,
"customCron": "<string>",
"dayOfMonth": 123,
"dayOfWeek": 123,
"hour": 123,
"minute": 123,
"notificationEnabled": True,
"timezone": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dashboardId: 123,
customCron: '<string>',
dayOfMonth: 123,
dayOfWeek: 123,
hour: 123,
minute: 123,
notificationEnabled: true,
timezone: '<string>'
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications', 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://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications",
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([
'dashboardId' => 123,
'customCron' => '<string>',
'dayOfMonth' => 123,
'dayOfWeek' => 123,
'hour' => 123,
'minute' => 123,
'notificationEnabled' => true,
'timezone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications"
payload := strings.NewReader("{\n \"dashboardId\": 123,\n \"customCron\": \"<string>\",\n \"dayOfMonth\": 123,\n \"dayOfWeek\": 123,\n \"hour\": 123,\n \"minute\": 123,\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dashboardId\": 123,\n \"customCron\": \"<string>\",\n \"dayOfMonth\": 123,\n \"dayOfWeek\": 123,\n \"hour\": 123,\n \"minute\": 123,\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dashboardId\": 123,\n \"customCron\": \"<string>\",\n \"dayOfMonth\": 123,\n \"dayOfWeek\": 123,\n \"hour\": 123,\n \"minute\": 123,\n \"notificationEnabled\": true,\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"cronExpression": "<string>",
"dashboardId": 123,
"deploymentId": 123,
"humanReadableSchedule": "<string>",
"id": 123,
"isEnabled": true,
"notificationEnabled": true,
"notificationFormat": "<string>",
"timezone": "<string>"
}🔒 Admin only. Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
Creates a scheduled notification — a recurring run of a dashboard whose rendered result is delivered to its recipients. The cadence is set by
scheduleType plus the relevant time fields (minute, hour, dayOfWeek, dayOfMonth) or a raw customCron expression when scheduleType is CUSTOM; timezone defaults to UTC. The target dashboardId must belong to this deployment, otherwise 404 is returned. The created notification has no recipients — add them via POST /notifications/{id}/recipients.Authorizations
Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.
Path Parameters
Numeric id of the deployment that owns the notification.
Body
application/json
CreateNotificationInput
Dashboard to run on the schedule
Available options:
HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM Custom cron expression (required if scheduleType is CUSTOM)
Day of month (1-31)
Day of week (0-6, Sunday=0)
Hour of the day (0-23)
Minute of the hour (0-59)
Available options:
png, pdf Timezone for the schedule (e.g. "America/New_York")
Response
200 - application/json
Human-readable description of the cron schedule