Notifications

Create a scheduled notification

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

Request

  • Base URL: https://your-tenant.cubecloud.dev
  • URL: https://your-tenant.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications
  • Auth: HTTP bearer

Path parameters

deploymentIdinteger required

Numeric id of the deployment that owns the notification.

Request body

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)

notificationAiSummaryboolean nullable

Include an AI-generated "what changed" summary in the notification body. Off by default.

notificationEnabledboolean nullable
notificationFormat'png' | 'pdf' | 'pdf_print'
scheduleType'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'CUSTOM' required
timezonestring nullable

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

Response

cronExpressionstring required
dashboardIdinteger required
deploymentIdinteger required
humanReadableSchedulestring required

Human-readable description of the cron schedule

idinteger required
isEnabledboolean required
notificationAiSummaryboolean required

Whether this notification carries an AI-generated "what changed" summary in its body.

notificationEnabledboolean required
notificationFormatstring required
timezonestring required

Changes

  • adc4919489f4Revision changes
    • warning

      added the new in_month enum value to the /////// response property for the response status

    • warning

      added the new in_quarter enum value to the /////// response property for the response status

    • warning

      added the new in_year enum value to the /////// response property for the response status

    • warning

      added the new not_in_month enum value to the /////// response property for the response status

    • warning

      added the new not_in_quarter enum value to the /////// response property for the response status

    • warning

      added the new not_in_year enum value to the /////// response property for the response status

    • info

      added the new in_month enum value to the request property ///////

    • info

      added the new in_quarter enum value to the request property ///////

    • info

      added the new in_year enum value to the request property ///////

    • info

      added the new not_in_month enum value to the request property ///////

    • info

      added the new not_in_quarter enum value to the request property ///////

    • info

      added the new not_in_year enum value to the request property ///////

  • 1091747b43b9Revision changes
    • info

      added the new pdf_print enum value to the request property ////