Inbox quick start guide

All you need to know before starting to use our web and mobile inbox

This communications channel allows to you to display messages for on-site or in-app customers in their personal inbox in your website or mobile app. You can configure whether you want the messages to remain in their inboxes or to expire. Inbox messages allows you to engage users with rich content.


Inbox messages are targeted to user profiles, not to devices. Messages will be available to any device associated to that user profile via setting the user ID.

Enabling the inbox channel

To be able to use the Inbox channel, it must first be enabled by a Project Admin user, in Settings > Channels > Enabled Channels by toggling the Inbox slider and clicking on Save. Once you do, a new tab called Inbox Settings will appear in this page; navigate to it by clicking on it. Review our guide on inbox settings here for more details.

Prerequisites for the inbox on your website and apps

Website inbox

In order to use the inbox in your website you first need to integrate the Xtremepush SDK in your website by following the website integration guide. When you have added the SDK and enabled the website inbox, a default icon will appear overlaid on your site.

In settings this can be set to be top left/right but you can also manipulate the position and look via CSS. Details on how to fully customise this can be found here. If you want to build a fully custom inbox that is more natively integrated into your web app, this is also possible. You can build your own inbox and populate it with content from the inbox feed via API.

App inbox

If you want to use the inbox in your app you first need to integrate the Xtremepush SDK by following the guides on how to do this for Android apps and iOS apps. To add the inbox to your app you will need to enable the Android / iOS inbox and add a button to your app that can be pressed to open the inbox. It is straightforward to implement with an SDK method to enable the inbox and a method to open the inbox.

There are native methods for adding the inbox to your app for Android and iOS. Skip to the appropriate section for the type of app you are working with to get details on the OS specific variations when adding the Inbox. See how to do so for Android or iOS. You can customise the look of your app inbox from settings.


Running tests is encouraged before start sending inbox campaigns. You'll find details on how to test below.

Testing the inbox channel

Once you have enabled the inbox channel and configured it in your website or mobile app, you will be able to see inbox as an available channel from the campaign builder page. Inbox messages can be added as a complimentary channel to a campaign that also includes a notification or another comms channel. One common use case is to add a copy of a notification to the inbox to persist it on the site. Another is to use the inbox as a fallback channel for users who have not opted-in to other notifications.

You can now test sending an inbox campaign by navigating to Campaigns > Create Campaign > Send now or Schedule Message selecting Inbox or Campaigns > Create Campaign > Inbox content (this option doesn't allow you to combine inbox messages with other communication channels.

You can review more details about how to set up an inbox campaign in this guide and you should also check our inbox creative guidelines for best results.

Navigate to the Segment tab to specify the recipients of the campaign. If you have enabled the inbox for both website and Android / iOS you can specify which app you want to target, otherwise the content will appear in both your mobile apps and your website. Also if you have multiple users and you want to target a particular one, you can do so by selecting Identifier > users IDs equals condition (this will only work if you have previously set your user ID in the Segmentation Engine.


Count recipients before launching the campaign

Whenever launching a campaign it is a best practice to use the Calculate feature to count recipients and make sure that your targeted audience for this campaign is what you are expecting.

Managing your inbox feed

Once you have sent some inbox messages, managing the inbox is a little different to other comms channels, since once sent, messages have the ability to stay in your users' inbox. However, you can manage whether you want the messages to persist indefinitely or to expire on a given day or after some time from the Schedule tab of your campaign. Once that you have sent the campaign, you can use the inbox feed to expire inbox messages.

Updated 2 months ago

Inbox quick start guide

All you need to know before starting to use our web and mobile inbox

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.