Notifications
Notifications have two parts:- Channels are reusable destinations (email, Slack, Discord, Telegram) that receive alerts. They belong to your account.
- Schedule preferences decide which outcomes (
failure,success, both, or none) notify you for a given schedule and which channels receive them.
Available channel types and notification options depend on your plan. Requests
that exceed a plan limit return a
PLAN_LIMIT_EXCEEDED error.Channels
List channels
Promise<NotificationChannel[]> (secrets are never included)
Create a channel
Theconfig shape depends on type.
Promise<NotificationChannel> (unverified until you verify it)
Verify a channel
Sends a test notification and marks the channel verified on success.Promise<NotificationChannel>
Get, update, and delete
type is immutable. Changing the delivery destination (for example
a new webhook URL or email address) resets the channel to unverified, so call
verifyNotificationChannel again before it can send. A label-only change keeps
its verified status.
Deleting a channel automatically detaches it from any schedule preferences that
referenced it.
Schedule preferences
Get a schedule’s preference
Promise<ScheduleNotificationPreference> (unset schedules return
notifyOn: "none" with no channels)
Set a schedule’s preference
Promise<ScheduleNotificationPreference>
Rules enforced by the API:
channelIdsis required (non-empty) whennotifyOnis not"none".- Every channel id must reference a verified channel you own.
successandbothrequire at least one webhook channel (Slack, Discord, or Telegram); email is not delivered per success.- Some
notifyOnvalues are gated by plan.
warning (for example, when
enabling per-success notifications on a very high-frequency schedule).