Push Notifications

Push notifications - User Journey

The Push Notification feature within the SME app ensures seamless communication by delivering real-time notifications directly to users' mobile devices. With the ability to send targeted and personalised messages, you can drive engagement and guide users to relevant pages within your app environment.

Users can easily access their Push Notifications within the SME app by enabling notifications in their device settings. Tapping on a specific push notification directs users to the relevant destination screen within the app. This could include a custom workflow page or other app sections.

Data Model

You will need to use this model when sending a push notification:

PUSH_NOTIFICATION

The following values are available for you to use the API:

String externalId: Use it to save your own id to track and analyse your notifications
Map<String, Object> data: Contain the information of the notification
TranslateLabel titleI18n: Must contain the title translations
String es
String en
String zh
Please make sure to add value to all languages configured for your Customer

TranslateLabel messageI18n: Must contain the message translations
String es
String en
String zh
Please make sure to add value to all languages configured for your Customer

String externalType: Use it to define the external type of the notification for your own tracking and report
List receivers: Contain the id’s of the entities that will receive the notification
String merchantId
List userIds

Please make sure to always provide merchant id along with the user id


Sending a PUSH_NOTIFICATION

With this endpoint you will be able to send push notifications to be shown to the user on their mobile device.

Toqio delivery and support team will provide you with an API-Key to fill the header x-api-key value.

Use targetScreen to set up a redirect to a particular screen. For some screens you will need to add other parameters to enable the correct redirect.

For example, to redirect to a particular card screen, you will need to add target screen CARD_DETAILS and cardID to identify a particular card.