NotificationTypeConfig Metadata Type Guide

Architectural Overview#

NotificationTypeConfig configures the delivery channels enabled for individual notification types in Salesforce. While CustomNotificationType defines the semantic entity representing a business alert (such as High Priority Escalation or Deal Won), NotificationTypeConfig specifies the downstream delivery matrix: whether the event broadcasts to desktop Lightning notifications, mobile push devices, or Slack workspaces.

Architecturally, separating the notification schema from its channel delivery configuration allows DevOps teams to customize alerting destinations by environment, prevent unwanted push notifications in development tiers, and govern multi-channel messaging policies declaratively.

Directory and File Conventions#

NotificationTypeConfig files are located in the notificationTypeConfigs/ folder within modern SFDX source trees.

Key Metadata Fields#

The configuration fields defined in NotificationTypeConfig include:

Declarative XML and Package Manifest Examples#

Below is an enterprise notification configuration delivering critical case escalations across desktop, mobile, and Slack:

<?xml version="1.0" encoding="UTF-8"?>
<NotificationTypeConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <notificationType>Case_Escalation</notificationType>
    <desktopEnabled>true</desktopEnabled>
    <mobileEnabled>true</mobileEnabled>
    <slackEnabled>true</slackEnabled>
</NotificationTypeConfig>

Package Manifest (package.xml)#

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

CLI Retrieval and Deployment Commands#

Manage notification channel configurations with the Salesforce CLI:

# Retrieve custom notification types and their configs
sf project retrieve start --metadata NotificationTypeConfig:Case_Escalation

# Deploy all notification configurations
sf project deploy start --metadata NotificationTypeConfig

Architect Best Practices and Gotchas#

• Deploy Pre-requisites: Always bundle NotificationTypeConfig with its corresponding CustomNotificationType. Deploying a config referencing a non-existent notification type triggers deployment failure.
• Alert Fatigue Governance: Avoid enabling mobile push and Slack channels indiscriminately across all automated events. Reserve high-interrupt channels (mobile and Slack) for SLA violations, security alerts, and high-urgency assignments.
• Org-Wide Notification Prerequisite: Ensure NotificationsSettings has enableMobilePushDelivery: true if mobileEnabled is set to true in NotificationTypeConfig, otherwise mobile delivery remains suppressed.

Frequently asked questions

What is the role of NotificationTypeConfig in Salesforce?

NotificationTypeConfig specifies which physical channels, such as desktop bell, mobile push, or Slack, a notification type delivers to.

Can NotificationTypeConfig route custom notifications to Slack channels?

Yes. It configures whether custom notification types are dispatched to Slack integrations or Salesforce desktop and mobile endpoints.

Where is NotificationTypeConfig stored in an SFDX source structure?

It is stored in the force-app/main/default/notificationTypeConfigs/ directory with the suffix .notificationTypeConfig-meta.xml.