---
schema_version: "1"
id: b4c543c382ead0c83ee218d095759e97233c550d250d831ff47d2f9a19addb3c
title: NotificationTypeConfig
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_notificationtypeconfig.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_notificationtypeconfig.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 40d0423f12d39f346ef80b0a1aee2a29d323a187b69d70c03b831f4a47fc528b
description: Represents the metadata associated with org-level notification settings for standard and custom notification types. This type extends the Metadata metadata type and inherits its fullName field.
---
# NotificationTypeConfig

Represents the metadata associated with org-level notification settings for standard and custom notification types. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

NotificationTypeConfig components have the suffix .config and are stored in the notificationTypeConfig folder.

## Version

NotificationTypeConfig components are available in API version 48.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| notificationTypeSettings | [NotificationTypeSettings](#notificationTypeSettings)\[\] | An array of delivery settings for an org’s notification types. |

## NotificationTypeSettings

Represents the delivery settings for a standard or custom notification type.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d704442e141">Field Name</th>

              <th class="featureTableHeader  " id="d704442e144">Field Type</th>

              <th class="featureTableHeader  " id="d704442e147">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d704442e141" data-title="Field Name"><span class="keyword parmname">notificationType</span></td>

              <td class="entry" headers="d704442e144" data-title="Field Type">string</td>

              <td class="entry" headers="d704442e147" data-title="Description">
                <p class="p">Required. Specifies a notification type’s API name.</p>

                <p class="p">For standard notification types, this is the predefined API name
                  of the standard notification type. For custom notification
                  types, this is the API name of the custom notification type. If
                  a custom notification type was installed with a managed package,
                  it includes the namespace prefix.</p>

                <p class="p">Retrieve NotificationTypeConfig to see the API names of the
                  notification types available in your org.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d704442e141" data-title="Field Name"><span class="keyword parmname">appSettings</span></td>

              <td class="entry" headers="d704442e144" data-title="Field Type">
                <a class="xref" href="#appSettings">AppSettings</a>[]
              </td>

              <td class="entry" headers="d704442e147" data-title="Description">An array of settings for the connected apps supported for a
                notification type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d704442e141" data-title="Field Name"><span class="keyword parmname">notificationChannels</span></td>

              <td class="entry" headers="d704442e144" data-title="Field Type"><a class="xref" href="#notificationChannels">NotificationChannels</a></td>

              <td class="entry" headers="d704442e147" data-title="Description">Defines the delivery channels for a notification type.</td>

            </tr>

          </tbody>

        </table>

## AppSettings

Represents the settings for the connected apps supported for a notification type.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d704442e234">Field Name</th>

              <th class="featureTableHeader  " id="d704442e237">Field Type</th>

              <th class="featureTableHeader  " id="d704442e240">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d704442e234" data-title="Field Name"><span class="keyword parmname">connectedAppName</span></td>

              <td class="entry" headers="d704442e237" data-title="Field Type">string</td>

              <td class="entry" headers="d704442e240" data-title="Description">Required. Specifies the API name of a connected app. If a
                connected app is installed with a managed package, it includes the
                namespace prefix.<p class="p">Retrieve NotificationTypeConfig to see the API
                  names of the connected apps supported for a notification
                  type.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d704442e234" data-title="Field Name"><span class="keyword parmname">enabled</span></td>

              <td class="entry" headers="d704442e237" data-title="Field Type">boolean</td>

              <td class="entry" headers="d704442e240" data-title="Description">Indicates whether a connected app is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) for the notification
                type.</td>

            </tr>

          </tbody>

        </table>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If an Enhanced Connected App (ECA) and a Connected App (CA) share the same name, or if the CA has been migrated to an ECA, only the ECA is returned when you retrieve NotificationTypeConfig.

- The CA settings aren't applied when you deploy the retrieved settings to a new org and the CA and ECA share the same name.
- In existing orgs, app settings for CAs that share a name with an ECA or have been migrated to an ECA can't be changed via the Metadata API. To change these app settings, use the UI.

## NotificationChannels

Represents the settings for the delivery channels for a notification type.

| Field Name | Field Type | Description |
| --- | --- | --- |
| desktopEnabled | boolean | Indicates whether desktop notifications are enabled (true) or not (false). |
| mobileEnabled | boolean | Indicates whether mobile notifications are enabled (true) or not (false). |
| slackEnabled | boolean | Indicates whether Slack notifications are enabled (true) or not (false). |

## Declarative Metadata Sample Definition

The following is an example of a NotificationTypeConfig component.

<NotificationTypeConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <notificationTypeSettings>
        <notificationType>chatter\_mention</notificationType>
        <notificationChannels>
            <desktopEnabled>false</desktopEnabled>
            <mobileEnabled>true</mobileEnabled>
        </notificationChannels>
        <appSettings>
            <connectedAppName>Datawatch</connectedAppName>
            <enabled>false</enabled>
        </appSettings>
            <appSettings>
            <connectedAppName>package2\_\_ConnectedApp2</connectedAppName>
            <enabled>true</enabled>
        </appSettings>
    </notificationTypeSettings>
   <notificationTypeSettings>
        <notificationType>namespace\_\_Custom\_Notification</notificationType>
        <notificationChannels>
            <desktopEnabled>true</desktopEnabled>
            <mobileEnabled>true</mobileEnabled>
        </notificationChannels>
        <appSettings>
            <connectedAppName>namespace\_\_Connected\_App</connectedAppName>
            <enabled>false</enabled>
        </appSettings>
        <appSettings>
            <connectedAppName>namespace2\_\_ConnectedApp2</connectedAppName>
            <enabled>true</enabled>
        </appSettings>
    </notificationTypeSettings>
</NotificationTypeConfig>

The following is an example of a package manifest used to retrieve all the available notification settings for an organization, by using a wildcard:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>NotificationTypeConfig</name>
    </types>
    <version>48.0</version>
</Package>

## Wildcard Support in the Manifest File

This metadata type supports 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).