v7

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01120263252.9 KB

Notifications

Create a scheduled notification

post/api/v1/deployments/{deploymentId}/notifications

deploymentIdinteger required

Numeric id of the deployment that owns the notification.

customCronstring nullable

Custom cron expression (required if scheduleType is CUSTOM)

dashboardIdinteger nullable

Numeric id of the dashboard to run on the schedule. Provide this OR dashboardPublicId (exactly one).

dashboardPublicIdstring nullable

Public id of the dashboard to run on the schedule. Provide this OR dashboardId (exactly one).

dayOfMonthinteger nullable

Day of month (1-31)

dayOfWeekinteger nullable

Day of week (0-6, Sunday=0)

hourinteger nullable

Hour of the day (0-23)

minuteinteger nullable

Minute of the hour (0-59)

notificationEnabledboolean nullable

notificationFormat'png' | 'pdf'

scheduleType'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'CUSTOM' required

timezonestring nullable

Timezone for the schedule (e.g. "America/New_York")

cronExpressionstring required

dashboardIdinteger required

deploymentIdinteger required

humanReadableSchedulestring required

Human-readable description of the cron schedule

idinteger required

isEnabledboolean required

notificationEnabledboolean required

notificationFormatstring required

timezonestring required