---
schema_version: "1"
id: 2ea5a3631bd2d47bd981a7962c830d5a4d7c35c97015f54c87995ed99f27c531
title: iOS Custom Push Payload Content
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/connected_app_custom_push_payload_ios.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.connected_app_custom_push_payload_ios.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: aafdea90144ae66c822805ba5666235cb036a7f0b9e262e7748da09ac365a611
description: Use these keys and values to create custom iOS push notifications for your connected app.
products:
  - Security
  - Cross Cloud
release: "264"
---
# iOS Custom Push Payload Content

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

### Required Editions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small edition">
      <colgroup>
        <col>
      </colgroup>
      <tbody>
        <tr class="">
          <td class="slds-cell-wrap" style="vertical-align:top;">Available in: Lightning Experience</td>

        </tr>
        <tr class="">
          <td class="slds-cell-wrap" style="vertical-align:top;">
            <p>Connected Apps can be created in: <strong>Group</strong>, <strong>Essentials</strong>,
              <strong>Professional</strong>, <strong>Enterprise</strong>, <strong>Performance</strong>, <strong>Unlimited</strong>, and
              <strong>Developer</strong> Editions
            </p>
            <div>
              <p>Connected Apps can be installed in: <strong>All</strong>
                Editions</p>
              <div class="slds-box slds-box_x-small slds-theme_shade slds-m-top_medium slds-m-bottom_medium">
                <div class="slds-media slds-media_responsive">
                  <div class="slds-media__figure"><span class="slds-icon_container slds-icon_container_circle slds-icon-note-note"><img style="margin-bottom:0;" src="https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-identity-264-0-0-production-enus/699dab6f-8f1a-4662-b24f-6521d5b747f7/images/icon_note.png" alt="Note"></span></div>
                  <div class="slds-media__body" style="padding-top:.5rem;padding-bottom:.5rem;"><span class="slds-text-title_caps">Note</span> 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 <a href="https://help.salesforce.com/s/articleView?id=xcloud.external_client_apps.htm&amp;language=en_US" target="_blank">external client apps</a> instead. If you must
                    continue creating connected apps, contact Salesforce Support. <p>See <a href="https://help.salesforce.com/s/articleView?id=005228017&amp;type=1&amp;language=en_US" target="_blank">New connected apps can no longer be created in Spring
                        ‘26</a> for more details.</p>
                  </div>
                </div>
              </div>
            </div>
          </td>

        </tr>
      </tbody>
    </table> <table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small " summary="APS Dictionary Keys">
      <caption>APS Dictionary Keys</caption>
      <colgroup>
        <col style="width:33.33333333333333%">
        <col style="width:33.33333333333333%">
        <col style="width:33.33333333333333%">
      </colgroup>
      <thead class="slds-text-title_caps ">
        <tr class="">
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e102">Payload Key</th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e105">Description</th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e108">Value</th>
        </tr>
      </thead>
      <tbody>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e102 ">
            <code>sound</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e105 ">Sound played on alert display.</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e108 ">
            <code>default</code>
          </td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e102 ">
            <code>badge</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e105 ">Number displayed in a badge on your app’s icon.</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e108 ">Count of unseen notifications</td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e102 ">
            <code>mutable-content</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e105 ">
            <p>Indicates payload content that requires handling by the notification extension.</p>
            <p style="margin-bottom:0;">Included with encrypted payloads only.</p>
          </td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e108 ">
            <code>true</code>
          </td>

        </tr>
      </tbody>
    </table> <table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small " summary="Alert Dictionary Keys">
      <caption>Alert Dictionary Keys</caption>
      <colgroup>
        <col style="width:33.33333333333333%">
        <col style="width:33.33333333333333%">
        <col style="width:33.33333333333333%">
      </colgroup>
      <thead class="slds-text-title_caps ">
        <tr class="">
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e192">Payload Key</th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e195">Description</th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e198">Value</th>
        </tr>
      </thead>
      <tbody>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e192 ">
            <code>title</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e195 ">
            <p>Alert title. Displayed by default for iOS remote notifications</p>
            <p style="margin-bottom:0;">For encrypted payloads, the MSDK notification extension extracts and displays the custom
              <code>alertTitle</code> key value supplied in encrypted
              content.
            </p>
          </td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e198 ">Empty string</td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e192 ">
            <code>body</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e195 ">Alert body. Displayed by default for iOS remote notifications</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e198 ">
            <p style="margin-bottom:0;">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.</p>
          </td>

        </tr>
      </tbody>
    </table> <table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small " summary="Custom Keys">
      <caption>Custom Keys</caption>
      <colgroup>
        <col style="width:33.33333333333333%">
        <col style="width:33.33333333333333%">
        <col style="width:33.33333333333333%">
      </colgroup>
      <thead class="slds-text-title_caps ">
        <tr class="">
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e267">Payload Key</th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e270">Description</th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e273">Value</th>
        </tr>
      </thead>
      <tbody>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e267 ">
            <code>content</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e270 ">
            <p>Encrypted payload content</p>
            <p style="margin-bottom:0;">See the Encrypted Content Keys table for content details.</p>
          </td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e273 ">AES encrypted and base64 encoded payload content</td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e267 ">
            <code>secret</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e270 ">Symmetric encryption key</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e273 ">RSA encrypted and base64 encoded AES key and IV bytes</td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e267 ">
            <code>encrypted</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e270 ">Encrypted payload indicator</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e273 ">
            <code>true</code>
          </td>

        </tr>
      </tbody>
    </table> <table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small " summary="Encrypted Content Keys">
      <caption>Encrypted Content Keys</caption>
      <colgroup>
        <col style="width:33.33333333333333%">
        <col style="width:33.33333333333333%">
        <col style="width:33.33333333333333%">
      </colgroup>
      <thead class="slds-text-title_caps ">
        <tr class="">
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e354">Payload Key</th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e357">Description</th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d29775e360">Value</th>
        </tr>
      </thead>
      <tbody>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e354 ">
            <code>oid</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e357 ">Organization ID</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e360 ">ID of org where notification originated</td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e354 ">
            <code>uid</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e357 ">Recipient User ID</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e360 ">ID of notification recipient</td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e354 ">
            <code>nid</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e357 ">Notification ID</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e360 ">ID of the notification</td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e354 ">
            <code>type</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e357 ">Notification type class</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e360 ">
            <code>-1</code>
          </td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e354 ">
            <code>sid</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e357 ">Source ID</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e360 ">ID of record associated with notification</td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e354 ">
            <code>rid</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e357 ">Related ID</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e360 ">N/A (reserved for future use)</td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e354 ">
            <code>cid</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e357 ">Experience Cloud site ID</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e360 ">ID of Experience Cloud site for the notification</td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e354 ">
            <code>notifType</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e357 ">Notification type ID</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e360 ">ID of the custom notification type</td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e354 ">
            <code>alertTitle</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e357 ">Notification alert title</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e360 ">
            <ul>
              <li>If full content push notifications are enabled for the app: Custom notification
                title</li>

              <li>If full content push notifications aren’t enabled for the app: Empty string</li>

            </ul>
          </td>

        </tr>
        <tr class="">
          <td data-label="Payload Key" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e354 ">
            <code>alertBody</code>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e357 ">Notification alert body</td>

          <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d29775e360 ">
            <ul>
              <li>If full content push notifications are enabled for the app: Custom notification
                body</li>

              <li>If full content push notifications aren’t enabled for the app: Custom notification
                title</li>

            </ul>
          </td>

        </tr>
      </tbody>
    </table>