Skip to main content

Push Notification Credentials

For the Atomic platform to deliver push notifications to your apps, you'll need to configure credentials for each relevant platform.

Add and manage notification platforms here, so your customers can receive native mobile notifications, then continue to the SDK guide to complete the configuration for iOS, Android, Flutter, React Native, or Cordova.

Add push notification credentials​

You must have access to the Notification Platform resource to be able to add notification credentials. See more in Workbench members

  1. Open the Atomic Workbench, navigate to 'Configuration' and under SDK select 'Notifications'. Alternatively, open the command palette, type Notifications and select Configuration > Notifications.

    Workbench view of creating a push notification credential
    Add a new push notification credential

  2. Click 'New platform', and select iOS, iOS Sandbox or FCM HTTP V1 (Android).

    Workbench view of creating a push notification credential
    Add a new push notification credential

  3. Enter the required information to register the corresponding platform:

For iOS​

Workbench view of creating a push notification credential for iOS
Add a new push notification credential for iOS

  • Platform: You have two configuration options: iOS and iOS Sandbox. The iOS Sandbox configuration is for development purposes and is applicable only to apps installed via Xcode build. For apps distributed via TestFlight or the App Store, the iOS configuration is required.

  • App Id: Your application's unique identifier. As registered with APNS, this is the identifier used in the Atomic SDKs when registering or deregistering for notifications.

  • Authentication Type: Use a push certificate or a token to implement notifications.

  • Authentication configuration:

    • Token Authentication: A team identifier, your app's bundle ID, a signing key id and the p8 export of your signing key.
    • Certificate Authentication: The password for the P12 export if applicable and a P12 export of your push notification certificate and private key. Note: For iOS Sandbox, you can use either the Apple Push Notification service SSL (Sandbox) or the Apple Push Notification service SSL (Sandbox & Production). However, for the iOS configuration, only the Apple Push Notification service SSL (Sandbox & Production) will work.

See the SDK guide for instructions on setting up push notifications on iOS in the Atomic SDK.

Sharing an App ID between iOS and iOS Sandbox

As of iOS SDK 25.4.0, you can configure both the iOS and iOS Sandbox push notification platforms with the same app ID.

If you share an app ID across both environments, all devices must use iOS SDK 25.4.0 or greater. Earlier versions may cause tokens to register against the wrong platform.

For Android​

Workbench view of creating a push notification credential for Android

Add a new push notification credential for Android via the Workbench

You need to have configured FCM HTTP v1 before proceeding. You can then configure the FCM credentials in the Atomic workbench (or via API) by providing:

  • Platform: FCM HTTP V1.
  • Application Id: Your application's unique identifier. As registered with Firebase, this is the identifier used in the Atomic SDKs when registering or deregistering for notifications.
  • Service account private key: The contents of your Firebase service account private key file (JSON).
  • Channel Id (optional): maps to the android_channel_id option as documented by Firebase.
  • Restricted package name (optional): maps to the restricted_package_name option as documented by Firebase.

See the SDK guide for instructions on setting up push notifications on Android in the Atomic SDK.

Enable notification badge settings​

Two configurable options are available to control the behaviour of notification badges. When enabled, these settings ensure that the notification payload includes the count of unread cards—used to update the badge number on the app icon.

Note: A card is considered unread if it has not been displayed in any of the containers to which it was sent.

Include count of unread cards in notification payload​

Enable this option to include the unread card count in push notification payloads. This option is essential if you'd like to keep badge counts up-to-date, especially when leveraging background push notifications to perform silent updates.

When this option is enabled - and the smart badge count is not enabled - the badge count is scoped to the container that the push notification is registered for.

Workbench view of the option including count of unread cards in notification payload
Include count of unread cards in notification payload

Smart badge count - send background notifications for unread count changes​

Premium feature

Smart badge count is a premium feature. Please contact us to have this feature enabled in your organization.

Enable this option to trigger background push notifications whenever the unread card count changes, such as when cards are published, viewed, or interacted with in any container. This ensures badge counts stay synchronized with the actual unread state of card feeds.

When this option is enabled, the badge count includes all unread cards for a customer across all streams by default. You can exclude individual streams from the count — see Excluding streams from the badge count below.

This setting operates independently of card push notifications. With this option enabled, badge counts will continue to update even if push notifications are disabled in the Action Flow editor for the cards being published.

On Android, background notifications must be handled explicitly by the host application and it is important to thoroughly test this in your application before enabling this feature. See Android badge counts for the recommended pattern and example code.

On iOS, badge count updates are handled directly by the system. However, if you'd like to leverage other capabilities of iOS background notifications, additional setup is required in the host application. See iOS Host app set-up for more details.

Excluding streams from the badge count​

Once this environment-level setting is enabled, you can choose to exclude certain streams from the count. If a card exists only in excluded streams then it will not be included in the badge count.

Workbench view of the option toggling background notifications at stream level
Toggle background notifications at container level

For example if you have three streams:

  • all cards (required) - excluded from the count
  • stream a - excluded from the count
  • stream b - included in the count

The badge count will function as follows:

  • If you send a card to "all cards" and "stream a" (both excluded) it will not be included in the count
  • If you send a card to one of "all cards" or "stream a" (both excluded) it will not be included in the count
  • If you send the card to just "stream b" (included) it will be included in the count
  • If you send the card to "stream a" and "stream b" (one excluded, one included) it will be included in the count

Analytic events​

As with regular push notifications an analytic event is emitted from Atomic whenever a smart badge count push notification is sent. This analytic event is called smart-badge-notification-sent.

Last updated on