CustomNotificationType

Represents the metadata associated with a custom notification type.

For more information about custom notifications, see Custom Notification Actions.

This type extends Metadata and inherits its fields.

The file suffix is .notiftype for the notification type definition. Notification types are stored in the notificationtypes directory of the corresponding package directory.

Introduced in API version 46.0.

• Type: CustomNotificationActionGroup[]
• Required: No
• Version: Beta.
• Description: Optional. Indicates whether mobile action groups are enabled, allowing users to take actions directly from mobile notifications.

• Type: string
• Required: Yes
• Description: Required. Specifies a notification type name. Maximum number of characters: 80.

• Type: string
• Required: No
• Description: Specifies a general description of the notification type, which is displayed with the notification type name. Maximum number of characters: 255.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the desktop delivery channel is enabled (true) or not (false).

• Type: string
• Required: Yes
• Description: Required. Specifies the label for the notification type.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the mobile delivery channel is enabled (true) or not (false).

• Type: boolean
• Required: No
• Description: Reserved for future use.

CustomNotificationActionDefinition represents the metadata that define an actionable notification.

• Type: string

• Required: Yes

• Description: Required.

  The name of the action seen in the push notification.

• Type: string

• Required: Yes

• Description: Required.

  Unique identifier of the action in an action group.

• Type: string
• Required: No
• Description: The name of the Apex class where the action is implemented.

• Type: NotificationActionType (enumeration of type string)

• Required: Yes

• Description: Type of action.

  Required.

  Values are:

• Possible values:

  • NotificationApiAction — Server-side action where client needs to make action API call.
  • Share — Client-side action where the app shares notification content to any channel.

CustomNotificationActionGroup represents the action group.

• Type: CustomNotificationActionDefinition[]
• Required: No
• Description: Represents the actions within a mobile action group.

• Type: string

• Required: Yes

• Description: Required.

  Unique name of the mobile action group.

The following is a definition of a custom notification type that is enabled for desktop and mobile.

1<CustomNotificationType xmlns="http://soap.sforce.com/2006/04/metadata">
2    <customNotifTypeName>Custom Notification</customNotifTypeName>
3    <desktop>true</desktop>
4    <masterLabel>Custom Notification</masterLabel>
5    <mobile>true</mobile>
6</CustomNotificationType>

This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.