Integrate OneSignal with your website
Learn how to integrate OneSignal with your website to send transactional notifications to users
There are many situations in which you will want to trigger push notifications to your users, here are some examples:
- A private message has been received
- An order has been delivered
- A new file has been added to the account
- A subscription is about to expire
For all of these examples, the notification will need to target a specific user when a specific event happens on your website. In order to be able to send these notifications you will need the following implemented into your website's code:
- OneSignal REST API
- Canvas native functions
Keep in mind that this is not an implementation guide for the OneSignal REST API, each server and website is different and will require a developer to find the best approach for integrating the OneSignal REST API. The purpose of this guide is to give you a better understanding of how to integrate your website with the Canvas platform for sending targeted, or transactional push notifications.
Let's go through each one of the requirements:
OneSignal REST API
Since Canvas uses OneSignal for push notifications, you will need to use the OneSignal REST API to trigger the notifications.
Whenever a push notification is expected to be sent, you will need to make a call to the OneSignal REST API with the notification details (title, text, link, image, tags, etc), this call must be implemented on your website.
Here you can find the complete documentation for the OneSignal REST API: https://documentation.onesignal.com/reference/create-notification
Canvas native functions
Implementing the OneSignal REST API should be straightforward, but at some point, you will ask yourself "How do I target a specific user?", and that's where the Canvas native functions come into play.
On your website, you are probably using a unique ID or even an email to identify your users, but in OneSignal that unique identifier is not available out of the box, so the idea here is to tell OneSignal to store the same unique user ID from your website into the OneSignal profile of that user.
nativeFunctions.onesignalSetExternalUserId function will tell the app to make a request to OneSignal and set the provided ID as the External User ID for the current device, which will allow you to target that specific user in your notifications using the exact identifier that you use on your website.
For more details on how to target users using the External User ID, you can refer to the OneSignal documentation here: https://documentation.onesignal.com/docs/external-user-ids
You can also find a list of all available native functions here: https://www.mobiloud.com/help/knowledge-base/how-to-use-canvas-functions