To get started with the On-Site Inbox for your website for your website you will need an account on xtremepush and to have a project configured. You can login at dashboard.xtremepush.com. Once logged in if you don't have one ready to use, add a NEW project.
Don't have a login?
If you are already a customer all accounts come with multi-user access and the person(s) in your organisation who is responsible for administration of user access will be able to provide appropriate user access to users who are; involved in the integration process, running campaigns etc. If you need help please contact your account manager or submit a support ticket.
If you are not a customer please request a demo.
If you are creating a New project you will need to enter the following details and click save to initialise your project:
- Title: Name used to identify project on the platform, something obvious to help you find it.
- Description: A short description of what the project is for.
- Timezone: The timezone used for analytics in the project. Important this will dictate the starting point for analytics like daily users. You can set this to the local timezone of platform users if this makes sense. Default is UTC, which is a good compromise if users are likely to be spread across different timezones.
- Icon: Helps to identify project on the platform, use app icon to help you find it.
Adding a website and Deploying the SDK
If you have already setup web push notifications on your site you will have already added a website and the SDK will already be deployed and you can skip to the next section. If not you will need to deploy the SDK.
If you haven't already added a website to your project go ahead and add one now.
Added websites appear listed in the Applications section. An application key that is used in the integration will appear in the table for each website and you can return to the Website Settings page as seen above by clicking on the Settings icon.
To integrate your web site you will want click the SDK Integration next to your website in the Applications table to go here:
It will have the code you need for deploying the SDK like below:
You can also deploy the SDK with Google Tag Manager
Enabling the Inbox Messaging Channel
To find out if the Inbox Messaging Channel has been enabled Go to Create Campaign > Send-Now or Schedule Notification. If you don't see the Inbox Channel as an option it is not enabled.
To enable it go to App Settings > Inbox Settings and to set In-App Messaging to Enabled and click save.
Return to Create Campaign > Send-Now or Schedule Notification and you will see the inbox channel as an option:
Setting Up the Inbox
Once the inbox is enabled you need to configure if you want to enable it for iOS and Android, and configure the look and feel of your inbox. This can all be done from App Settings > Inbox Settings. The Inbox has a two default styles Light and Dark (below) and you can also fully customise the look and feel of the inbox.
From App Settings > Inbox Settings you can configure the following colours in order to match the inbox to your branding:
When you have added the SDK and enabled the Inbox a default icon will appear overlaid at the top of 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 below:
And 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:
Setting Up a Message
Before you set up your first message please review our creative guidelines for the Inbox to get an understanding of how to create professional looking messages:
Then provided you have enabled the inbox and added it to your site, you are ready to setup your first campaign. Campaign setup is covered in our Platform Guide Docs:
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. Inbox messages can be trigged just like other messages one use case for this is basket or other drop-off recovery type messages:
Managing Your Inbox Feed
Once you have sent some messages managing the inbox is a little different to other comms channels. For channels like notification, SMS and email messages go to the notification tray or client application and can be managed by users from there on.
Once sent messages will stay in your users inbox. There is capability in campaign scheduling for messages that should not persist indefinitely for example an offer that expires on a given day or a message related to an event that is no longer relevant once the event is over. In campaigns that contain an inbox message on the schedule tab you will see the option to set when the inbox message should be removed:
If you need to check what inbox messages are still active in the Inbox you can check this out in Campaigns > Inbox Feed. From here you can also expire a message if needed for whatever reason. More details can be found on the Inbox Feed in the article linked below:
There is also an API method for removing messages from a users inbox feed. This can be used to expire a message based on some action for example if a user redeems an offer then the offer message could be removed from the user's inbox with this API call: