To get started with push notifications 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.
Add Web Applications to Project
Before you integrate next you will need to add the web applications you want to integrate in the Applications section of the project.
If you want to add a website select Add Website, when are adding a New Website you will need to enter some details, initially you can just add a name and click save to initialise your Website:
Name: Name used to identify website on the platform, something obvious to help you find it.
Website Name - The brand name of your site
Website Domains - Whitelist of site domains that you will be using - required or SDK will not work on your domain.
- Include http protocol prefix - https://example.com
- If using multiple domains place the different domains on separate lines
Icons: The default icon use .png format to be displayed in your web push notifications - required.
Small icon - 64px x 64px
Large icon - 256px x 256px
- Cookie Sharing Settings - (Optional) used to sync SDK across multiple subdomains where needed
- Push Notifications Settings - Various credential(s) needed to send push notifications on different browsers can be filled out later. Details on filling these out in docs for individual browsers. Optional if not doing Notifications.
After adding websites you will see they 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. From here you will be able to add/update notification credentials after adding your website for example.
For website entries in the applications table you will also see links to the SDK settings and SDK integrations pages used when setting up a website integration. Details on integrating your website for notifications in the next sections.
To enable notifications for the Chrome Browser you will also need an android developer accounts. From this account you will generate credentials required to send notifications to Chrome Browsers. These will then be uploaded to your project on xtremepush. You will need to know if your site is http or https. It is https then you will have to host two additional files:
A JSON manifest file in your website directory
If your site is http you will either need a suitable https subdomain to host the above or you can allow us to host them on an autogenerated https .webpu.sh subdomain for you. If self hosting in this scenario you will also need to host two further files on your https subdomain:
- A html file for the subscribe window that appears when users are prompted on the http domain but originates from the https domain - subscribe.html
- a html file for an iframe that will sync the two domains to maintain the push subscription - frame.html
Details on how to setup all of this up in Docs here:
The steps above for Chrome will also enable notifications for the Firefox Browser. You will just to enable the Firefox checkbox in settings if you want to support the Firefox Browser.
To enable notifications for the Safari Browser you will also need an iOS developer account. From this account you will generate credentials required to send notifications to the safari desktop browser on Mac. These will then be uploaded to your project on xtremepush. Details on how to do this in Docs here:
Completing the Integration
Once you have identified how best to integrate your site(s) and have prerequisites and important settings configured then you are ready to deploy our SDK on your site. Depending on choices taken and settings configured - the exact instructions and code required to deploy are automatically generated on the platform. Full details on how to add complete the integrations are in Docs here:
Deploying with Google Tag Manager
We are a Google Tag manager vendor partner so if you use Google Tag Manager you can also easily complete the integration using Google Tag Manager.
Notifications in Test and QA Environments
Most enterprises have multiple backend environments and builds of sites for various stage of their development cycle (e.g. Test, Staging, Production). To map their dev process on the xtremepush platform enterprises typically hook the various builds of their site into matching projects on the platform. This is very flexible and can generally map to any process.
The projects are logically separated by the application keys (found in project settings and used when integrating) so if you are sending notifications in a test environment there is no possibility you will send them out on the production app. This allows you to reuse your push credentials across the different projects for different builds of the same site:
Your user’s roles and access to projects can be managed using our UAM capabilities:
For further segregation and simplicity we can also create separate account for non production versions of your site so that the production site is further separated from non prod envs. Any API integrations with your backend are also kept logically separate by the different application tokens found in each project. This allows you to also map your backend envs to the appropriate project on our platform.