Loading
Salesforce now sends email only from verified domains. Read More
Identify Your Users and Manage Access
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            iOS Custom Push Payload Content

            You are here:

            1. Salesforce Help
            2. Docs
            3. Identify Your Users and Manage Access

            iOS Custom Push Payload Content

            Use these keys and values to create custom iOS push notifications for your connected app.

            Required Editions

            Available in: Lightning Experience

            Connected Apps can be created in: Group, Essentials, Professional, Enterprise, Performance, Unlimited, and Developer Editions

            Connected Apps can be installed in: All Editions

            Note
            Note Connected apps creation is restricted as of Spring ‘26. You can continue to use existing connected apps during and after Spring ‘26. However, we recommend using external client apps instead. If you must continue creating connected apps, contact Salesforce Support.

            See New connected apps can no longer be created in Spring ‘26 for more details.
            APS Dictionary Keys
            Payload Key Description Value
            sound Sound played on alert display. default
            badge Number displayed in a badge on your app’s icon. Count of unseen notifications
            mutable-content

            Indicates payload content that requires handling by the notification extension.

            Included with encrypted payloads only.

            		 true
            Alert Dictionary Keys
            Payload Key Description Value
            title

            Alert title. Displayed by default for iOS remote notifications

            For encrypted payloads, the MSDK notification extension extracts and displays the custom alertTitle key value supplied in encrypted content.

            		 Empty string
            body Alert body. Displayed by default for iOS remote notifications

            The custom notification title is supplied as the value for this key. For MSDK notification extension failures only, use this value in a body-only alert.
            Custom Keys
            Payload Key Description Value
            content

            Encrypted payload content

            See the Encrypted Content Keys table for content details.

            		 AES encrypted and base64 encoded payload content
            secret Symmetric encryption key RSA encrypted and base64 encoded AES key and IV bytes
            encrypted Encrypted payload indicator true
            Encrypted Content Keys
            Payload Key Description Value
            oid Organization ID ID of org where notification originated
            uid Recipient User ID ID of notification recipient
            nid Notification ID ID of the notification
            type Notification type class -1
            sid Source ID ID of record associated with notification
            rid Related ID N/A (reserved for future use)
            cid Experience Cloud site ID ID of Experience Cloud site for the notification
            notifType Notification type ID ID of the custom notification type
            alertTitle Notification alert title
            • If full content push notifications are enabled for the app: Custom notification title
            • If full content push notifications aren’t enabled for the app: Empty string
            alertBody Notification alert body
            • If full content push notifications are enabled for the app: Custom notification body
            • If full content push notifications aren’t enabled for the app: Custom notification title
             
            Loading
            Salesforce Help | Article