PayloadKit

Notifications

com.apple.notificationsettings

The payload that configures notifications.

iOS
iOS 9.3+exclusive

Configuration Keys (1)

KeyTypeTitle
NotificationSettingsrequired

An array of notification settings dictionaries.

arrayNotification Settings
NotificationSettingsItem

Notification settings for an app

dictNotification Setting
NotificationsEnabled

If 'true', enables notifications for this app. Available in iOS 9.3 and later and macOS 10.15 and later.

Default: true

booleanEnable Notifications
BundleIdentifierrequired

The bundle identifier of the app to which to apply these notification settings. Available in iOS 9.3 and later and macOS 10.15 and later.

stringApp Bundle Identifier
ShowInNotificationCenter

If 'true', enables notifications in the notification center for this app. Available in iOS 9.3 and later and macOS 10.15 and later.

Default: true

booleanShow in Notification Center
ShowInLockScreen

If 'true', enables notifications on the Lock Screen for this app. Available in iOS 9.3 and later and macOS 10.15 and later.

Default: true

booleanShow in Lock Screen
ShowInCarPlay

If 'true', enables notifications in CarPlay for this app. Available in iOS 12 and later.

Default: true

booleanShow in CarPlay
SoundsEnabled

If 'true', enables sounds for this app.

Default: true

booleanSounds Enabled
BadgesEnabled

If 'true', enables badges for this app. Available in iOS 9.3 and later and macOS 10.15 and later.

Default: true

booleanBadges Enabled
AlertType

The type of alert for notifications for this app: - '0': None - '1': Temporary Banner - '2': Persistent Banner Available in iOS 9.3 and later and macOS 10.15 and later.

Default: 1

Range: None (0), Banners (1), Alerts (2)

integerAlert Type
PreviewType

The type previews for notifications. This key overrides the value at Settings>Notifications>Show Previews. - '0' - Always: Previews will be shown when the device is locked and unlocked - '1' - When Unlocked: Previews will only be shown when the device is unlocked - '2' - Never: Previews will never be shown Available in iOS 14 and later.

Range: Always (0), When Unlocked (1), Never (2)

integerPreview Type
GroupingType

The type of grouping for notifications for this app: - '0': Automatic: Group notifications into app-specified groups. - '1': By app: Group notifications into one group. - '2': Off: Don't group notifications. Available in iOS 12 and later.

Default: 0

Range: Automatic - Group notifications app-specific groups (0), By App - Group notifications into one group (1), Off - Do not group notifications (2)

integerGrouping Type
CriticalAlertEnabled

If 'true', enables critical alerts that can ignore Do Not Disturb and ringer settings for this app. Available in iOS 12 and later and macOS 10.15 and later.

Default: false

booleanCritical Alert Enabled