Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
CustomNotificationType
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 the desktop delivery channel is enabled (true) or not (false). |
| masterLabel | string | Required. Specifies the label for the notification type. |
| mobile | boolean | Required. Indicates whether the mobile delivery channel is enabled (true) or not (false). |
| slack | boolean | Reserved for future use. |
Declarative Metadata Sample Definition
The following is a definition of a custom notification type that is enabled for desktop and mobile.
<CustomNotificationType xmlns="http://soap.sforce.com/2006/04/metadata">
<customNotifTypeName>Custom Notification</customNotifTypeName>
<desktop>true</desktop>
<masterLabel>Custom Notification</masterLabel>
<mobile>true</mobile>
</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.