A notification is a great way to let users/readers know when new content is available.
1. To start
Before you can start sending push notifications, make sure the required push notification configuration information has been added for your app on the platform.
Check out the following articles for help on how to setup your app for Push Notifications:
- For iOS:
- Step 1: Setup Key based authentication
- Step 2: Setting up Firebase Push Notifications
- For Android:
IMPORTANT NOTE:
If you activate push notifications for an existing app, you'll need to create an updated build of the app.
2. Testing
If you want to use push notifications in your app, we recommend to test this before going live. You can register a number of test devices (phones, tablets) and send a test message to these devices only. Read below for more details on how to do this.
We provide a special custom URL scheme that allows you to test push notifications before distributing the app to the public. If your app is already live, you can enter this tp-register-test-device://
to a discrete location in your app so your users don't register their devices by accident.
- Make sure push notifications for your app have been configured properly, as described above.
- After you have completed the setup (for iOS and/or Android), create a new or updated build of your app.
- On the platform, add a web link to your app with the URL
tp-register-test-device://
. - Install the app on your device and make sure the app has requested you to allow push notifications. Usually this requires you to open the app, close it and open it again before a pop-up will appear requesting your approval.
- Selecting the link in the app will then add the current device to the list of test devices for push notifications.
NOTE:
The test functionality on iOS devices is only available in Test Flight builds of your app. Android builds of your app can just be installed on your Android device to register as a test device and test your Push Notifications.
3. Sending Push Notifications
Sending Push Notifications is done from the left menu on the platform (see above).
You can send Plain or Rich Push Notifications. Rich Push Notifications can include an optional Title, Description and even an Image.
Do you want to link to a published content item? Make sure to send your push notification at least 5 minutes after you marked the content item as published live and without a publishing date in the future! This way, users clicking on the link in the push notification will be able to access the content.
3.1. Plain Push Notifications
- Type: Plain Push Notifications
- Message: Of course you want to include a Message in your Plain Push Notification. This Message can include 140 characters.
-
Link: You can attach a
tp-collection
url scheme. This way, when readers tap on the Push Notification, they will be redirected to the right Collection or Content Item. For more info, see Using custom URL Schemes in your app. - Send at: This way, a Push Notification can be sent out at a specified time in the future.
-
Which Devices: You can target specific segments of devices, i.e.:
- All devices: Will send the Push Notification to all registered devices.
- All iOS devices: Will send the Push Notification to all registered iOS devices.
- All Android devices: Will send the Push Notification to all registered Android devices.
- Specific test devices: Here you can select specific Test Devices as a target for your Push Notification. Fore more info, see Testing
3.2. Rich Push Notifications
- Type: Rich Push Notifications
- Title: Your Rich Push Notification can include a Title
- Description: The Description has no limitations in terms of the number of characters.
- Image: Your Rich Push Notification can include an optional Image.
-
Link: You can attach a
tp-collection
url scheme. This way, when readers tap on the Push Notification, they will be redirected to the right Collection or Content Item. For more info, see Using custom URL Schemes in your app. - Send at: This way, a Push Notification can be sent out at a specified time in the future.
-
Which Devices: You can target specific segments of devices, i.e.:
- All devices: Will send the Push Notification to all registered devices.
- All iOS devices: Will send the Push Notification to all registered iOS devices.
- All Android devices: Will send the Push Notification to all registered Android devices.
- Specific test devices: Here you can select specific Test Devices as a target for your Push Notification. Fore more info, see Testing
NOTE:
You will only be able to start sending notifications, when your app has been installed and opened on at least 1 device.