Platform OverviewIntegration HubConfiguration and Customisation
API Reference

User Center Notifications

Notification Center - User Journey

The Notification Center facilitates streamlined communication by displaying notifications within the SME web platform, SME mobile apps, and the Admin Portal. With the ability to send targeted messages to specific users across these platforms, you can enhance engagement and drive users to relevant pages within your web and app environments.

SME Web Platform

Accessing the Notification Center: Users can reach the Notification Center on the SME web platform by clicking the bell icon located in the header.

  • Notification List: Upon clicking the bell icon, users will be directed to a list of notifications.
  • Notification Interaction: A specific notification redirects users to the defined destination screen, as specified in the API request . For instance, the user may be directed to a custom page within a workflow.
    You can send messages to specific users, driving them to any page in the web platform.

SME App

The Notification Center is also accessible within the SME app, providing a consistent user experience across platforms.

Accessing the Notification Center: Users can reach the Notification Center in the SME app by tapping the bell icon located in the header.

  • Notification List: Upon tapping the bell icon, users will be presented with a list of notifications.
  • Notification Interaction: Tapping on a specific notification directs users to the designated destination screen, as specified in the API request . This may include a custom page within a workflow or other relevant sections of the app.

Admin Portal Web

The Notification Center is available within the Admin Portal, providing targeted notifications to Admin Portal users, generally speaking, a Customer’s employees managing merchants. These notifications can help highlight critical aspects of the business and guide users to relevant areas of the portal.

  • Accessing the Notification Center: Users can access the Notification Center in the Admin Portal by clicking the bell icon located in the header.
  • Notification List: Upon clicking the bell icon, users will see a list of notifications
  • Notification Interaction: Clicking on a specific notification redirects users to the designated destination screen, as specified in the API request . For example, users may be directed to a Client Detail page or other relevant sections within the Admin Portal.

Notification Centre API

Data Model

You will need to use these two possible models when sending a notification:

For SME web and app: USER_CENTER_NOTIFICATION
For admin portal: ADMIN_CENTER_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

Send a USER_CENTER_NOTIFICATION and ADMIN_CENTER_NOTIFICATION

Send new notifications using this endpoint .

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

Use targetScreen value 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.