CustomNotificationType

Represents the metadata associated with a custom notification type. Custom notification types allow you to send a custom desktop or mobile notification via a process or invocable API call.

For more information about custom notifications, see Custom Notification Actions. This type extends the Metadata metadata type and inherits its fullName field.

Declarative Metadata File Suffix and Directory Location

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

Version

CustomNotificationType components are available in API version 46.0 and later.

Fields

Field Name	Field Type	Description
customNotifTypeName	string	Required. Specifies a notification type name. Maximum number of characters: 80.
description	string	Specifies a general description of the notification type, which is displayed with the notification type name. Maximum number of characters: 255.
desktop	boolean	Required. Indicates whether desktop notifications are enabled (`true`) or not (`false`).
masterLabel	string	Required. Specifies the label for the notification type.
mobile	boolean	Required. Indicates whether mobile in-app and push notifications are enabled (`true`) or not (`false`).

Declarative Metadata Sample Definition

The following is a definition of a custom notification type.

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>

Wildcard Support in the Manifest File

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.

Metadata API Developer Guide