Share via

NotificationSettings Class

  • Reference

Notification settings for a schedule.

Constructor

NotificationSettings(*, status: str | EnableStatus | None = None, time_in_minutes: int | None = None, webhook_url: str | None = None, email_recipient: str | None = None, notification_locale: str | None = None, **kwargs)

Parameters

Name Description
status
Required
str or EnableStatus

If notifications are enabled for this schedule (i.e. Enabled, Disabled). Possible values include: "Enabled", "Disabled".
time_in_minutes
Required
int

Time in minutes before event at which notification will be sent.
webhook_url
Required
str

The webhook URL to which the notification will be sent.
email_recipient
Required
str

The email recipient to send notifications to (can be a list of semi- colon separated email addresses).
notification_locale
Required
str

The locale to use when sending a notification (fallback for unsupported languages is EN).

Keyword-Only Parameters

Name Description
status
Default value: None
time_in_minutes
Default value: None
webhook_url
Default value: None
email_recipient
Default value: None
notification_locale
Default value: None