ExtlClntAppNotificationSettings Metadata Guide

Architectural Overview#

ExtlClntAppNotificationSettings configures outbound mobile push notification channels within the Salesforce External Client App architecture. In modern omni-channel enterprise solutions, notifying field workers, sales agents, or service dispatchers in real-time when critical events occur (such as SLA breaches, order approvals, or high-priority case escalations) is a core capability.

Behind the scenes, dispatching a push notification requires Salesforce to authenticate securely with Apple Push Notification service (APNs) and Google Firebase Cloud Messaging (FCM). ExtlClntAppNotificationSettings establishes these technical credentials, manages APNs production versus sandbox environments, and specifies device registration endpoints.

By decoupling developer push gateway settings from subscriber push execution policies, mobile architects ensure seamless infrastructure maintenance without impacting business user notification preferences.

Directory and File Conventions#

ExtlClntAppNotificationSettings files reside within the extlClntAppNotificationSettings directory:

Key Metadata Fields#

The ExtlClntAppNotificationSettings schema includes the following configuration fields:

Declarative XML and Package Manifest Examples#

Below is a declarative XML definition of ExtlClntAppNotificationSettings configured for production enterprise mobile notifications:

<?xml version="1.0" encoding="UTF-8"?>
<ExtlClntAppNotificationSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <applePushNotificationEnvironment>Production</applePushNotificationEnvironment>
    <enableCustomPushNotifications>true</enableCustomPushNotifications>
    <deviceTokenEndpoint>https://push-gateway.enterprise.com/tokens/register</deviceTokenEndpoint>
</ExtlClntAppNotificationSettings>

Package Manifest (package.xml)#

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

CLI Retrieval and Deployment Commands#

Manage notification settings with the Salesforce CLI:

# Retrieve notification settings for the field operations app
sf project retrieve start --metadata ExtlClntAppNotificationSettings:Field_Operations_ECA

# Deploy notification settings to production
sf project deploy start --metadata ExtlClntAppNotificationSettings:Field_Operations_ECA

# Validate push notification deployment without committing
sf project deploy start --metadata ExtlClntAppNotificationSettings --dry-run

Architect Best Practices and Gotchas#

• APNs Environment Isolation: Never configure applePushNotificationEnvironment as Production in development sandboxes or scratch orgs. iOS development builds signed with development provisioning profiles will reject push payloads originating from the APNs production gateway.
• Annual Certificate Renewal Lifecycles: Apple APNs certificates expire annually. Establish automated calendar alerts and DevOps runbooks at least 30 days prior to certificate expiration to generate, validate, and deploy updated certificate metadata without service interruption.
• Token Invalidation Handling: Mobile device tokens are invalidated whenever users reinstall the mobile app or upgrade devices. Implement proper token invalidation handlers on your push gateway to prevent delivery failure spikes that can trigger vendor throttling.

Frequently asked questions

What capabilities are configured in ExtlClntAppNotificationSettings?

ExtlClntAppNotificationSettings configures mobile push notification credentials, APNs certificates, FCM server keys, and device token registration endpoints.

Why must push notification certificates be maintained via metadata?

Maintaining notification settings in version control allows automated CI/CD pipelines to validate and renew APNs and FCM credentials across environments.

Does ExtlClntAppNotificationSettings support both APNs and FCM?

Yes. It supports Apple Push Notification service for iOS devices and Firebase Cloud Messaging for Android devices within the External Client App framework.

What happens if an APNs certificate expires in this metadata type?

Salesforce will fail to dispatch outbound push notifications to iOS devices until an updated certificate is uploaded and deployed.