Inbox is an optional feature. If you are interested, please contact us.

The Inbox API allows you to fetch and process notifications that this user has previously received, even if their device was offline. You can then do anything you want with the data, such as making a "notification center", where the user can catch up with previous notifications in a list.

The API gives you access to the entire notification, including its raw payload. It also lets you know if the notification has already been read, and allows you to mark one or all notifications as such. Once received/stored in the inbox, your push notifications will remain for a 3 months period.

This screenshot is an example of what you can achieve with the Inbox API. Please note Batch does not include any UI.

Inbox android example

Picking the Right Fetcher

Installation Mode

This mode will fetch notifications from the current app installation, and nothing else. If the user clears the app's data, this inbox will be cleared. This is great for applications where your users don't have to log in.

In this mode, you can simply get the Inbox Fetcher with a context:

BatchInboxFetcher inboxFetcher = Batch.Inbox.getFetcher(context);

Note: This may cause privacy issues if your app has an identification system. Users sharing the same device and using different accounts in your app would be able to see the push history of previous users.

Custom User ID Mode

This mode will fetch notifications for the specified custom user ID, even if they just installed the application and already got notifications on another device logged in with the same user identifier. If your application has a login system, this is the mode you should use.

Since notifications can have sensitive content, you cannot get a user's notifications simply with their user identifier: Batch requires you to authenticate your request.

Getting Your Authentication Key

First, you will need your inbox secret key. You will find that in your dashboard, below your API keys. It is unique for every app.

Inbox secret dashboard screenshot

The authentication key is generated by computing a sha256 hmac hash of the API Key and the user identifier, using the secret as the key. Then, you have to encode the hash in a hexadecimal string.

For example, in PHP, that would be:

hash_hmac("sha256", $APP_API_KEY . $USER_ID, $INBOX_SECRET)

For the API Key "abcdef", user identifier "paul", and secret of "foobar", the expected authentication key would be 796f1ab5d119d1b2eab8201e60335b56d1befff40c0f80263d64a169a8fd2e45.

Important note: This hash HAS to be computed on your server. If you bundle the inbox secret in your application to compute the hash, attackers will be able to extract it, and read the notifications of any of your users

Getting the Fetcher Instance

Once you've got the authentication key from the server, you only have to give Batch the right user identifier and auth key tuple to get the Inbox Fetcher:

BatchInboxFetcher inboxFetcher = Batch.Inbox.getFetcher("paul", "796f1ab5d119d1b2eab8201e60335b56d1befff40c0f80263d64a169a8fd2e45");

Fetching Notifications

Now that you've got your fetcher instance, it's time to fetch notifications, and display them!

The inbox fetcher has several important methods:

  • getFetchedNotifications()
    This returns a copy of all the notifications that have been fetched. Useful for a list adapter.
    Warning: Calling this always makes a copy of the objects, so you should cache that method's result.
  • fetchNewNotifications()
    Allows you to fetch notifications that might have been received after the initial fetch. This is useful for implementing a refresh feature. This will erase the notification history returned by getFetchedNotifications() to ensure consistency: you should clear the other notification pages you've already from your cache.
  • fetchNextPage() Fetches the next page of notifications. Batch will not fetch all notifications at once, but only small batches of them in pages.
    Use this method to load more notifications.
  • hasMore()
    Lets you know if more notifications might be available. Use this to make an infinite list, or a "load more" button.

Note: BatchInboxFetcher and its methods are well documented using Javadoc. Unfortunately, Android Studio will not fetch it. Please use the web API Reference of BatchInboxFetcher to get detailed explanations about what every method does.

BatchInboxFetcher will not fetch any notification by default, so before trying to display anything, you will need to call fetchNewNotifications() or fetchNextPage()

Both fetch methods take a listener, which the SDK will call you back on either on failure, or success.
Success callbacks include information about the operation to operate on the data, but you can very well do with the global methods.

Note: By default, you will be called back on the thread that you called Batch.Inbox.getFetcher() on. Please see below if you want to change that behaviour.

Reading Notification Content

Once you've fetched notifications, you will end up with a list of BatchInboxNotificationContent objects.

These objects have everything you need to display these notifications:

  • Title
  • Body
  • Send timestamp (UTC)
  • Read state
  • Source (Campaign API/Dashboard or Transactional API)
  • Payload, in both Raw and Batch wrapped forms

If you want to use advanced information about the notification, you can call getPushPayload(), which will return a BatchPushPayload instance.

This object allows you to fetch information, such as the deeplink, or big picture/large icon image URLs.

Note: Just like when you get it using a broadcast receiver, the raw payload should be used carefully on keys you do not control:

  • "com.batch" is Batch's internal payload: You should not make any assumption about its content, nor depend on it. We reserve the right to change it at anytime, without warning.
  • Standard parsing good practices apply: Make sure to check every cast and handle errors gracefully, and never assume anything about the payload's content.

Marking Notifications as Read

Notifications can be marked as read in two ways:

  • By marking only one notification as read
    Use markAsRead(notification) with the notification you want to mark as read.
  • By marking all notifications as read
    Simply call markAllAsRead()

In both cases, the notifications will be marked as read locally, but refreshing them might mark them as unread again, as the server might not have processed the request. These methods return quickly, and are thus safe to call on your UI thread.

Note that notifications that have been opened when received are automatically marked as read.

Marking Notifications as Deleted

Notifications can be deleted using the markAsDeleted(notification) method with the notification you want to mark as deleted. A deleted notification will NOT appear in the notification list the SDK provides, it's your job to update your UI accordingly.

The notifications will be marked as deleted locally, but refreshing them might make them appear again, as the server might not have processed the request. These methods return quickly, and are thus safe to call on your UI thread.

Displaying Mobile Landing

Batch allows you to display a mobile landing attached to a notification. To do so, you can simply trigger the landing message from the BatchInboxNotificationContent object as following:

  • Kotlin
  • Java
fun onNotificationClicked(notification: BatchInboxNotificationContent) {
  if (notification.hasLandingMessage()) { 

Tweaking the Fetcher

For more advanced usages, you can also change various aspects of the Inbox Fetcher, such as:

  • The maximum number of notifications fetched per page (setMaxPageSize)
  • The maximum number of notifications that can be fetched using this object (setFetchLimit)
    A default limit is set to avoid going over memory by accident.
  • The handler that will be used to run the callbacks.
    By default, BatchInboxFetcher will call you back on the thread that you used to call Batch.Inbox.getFetcher(), but if for any reason you want to change the Handler used for callbacks, you should use setHandlerOverride()
  • 1.19.0 Disabling the filtering of silent notifications (setFilterSilentNotifications). A silent notification is a push that doesn't show any visible message to the user.

Testing Your Integration

In order to test your integration, you will need to create a push campaign on the dashboard or to target your installation ID/custom user ID using the Transactional API.

Please note you won't be able to test your implementation using the following methods:

  • Sending a test notification: from the Debug tool or using the "Send a test" button.
  • Targeting a specific push token: in case you are using the Transactional API.
  • Using the Dev API key: Inbox will only work with builds using the Live API key.