Notifications setup for pending user actions

This guide will help you understand how you, as a smallcase distribution module (DM) partner, can leverage smallcase Gateway's pending action webhook to notify your users about required action (Repair / Rebalance / SIP) on their invested smallcase.

Before you get started

What are pending actions?

When a user performs any kind of smallcase investment or any other action on the smallcase, a situation may arise possibly, where there is some kind of an action that a user needs to perform on the smallcase, to keep/maintain the smallcase in a consistent state.

Learn more in our explainer guide.

Why do I need to handle user communication?

User interacting with smallcase DM via your property is your user at the end of the day. Moreover, you would have existing communication mediums established with your users (via email, sms, mobile notification, etc). smallcase Gateway can rather be considered as a infrastructure provider, since we do not have front-facing property for users to directly interact with.

Hence, for smooth investing experience, it is recommended that smallcase DM partners directly reach out to their users. Of course, smallcase Gateway will help in providing relevant data at relevant times for partners to know what type of notifications to trigger.

Steps for communicating pending actions to your users/clients

create pending action webhook (docs)
you will get pending actions against each smallcaseAuthId (docs)

this smallcaseAuthId should already be linked with your registered users
use the pending action payload to send notification
when user clicks notification link, they should come to your app
once on the app, gateway SDK should be initialised with user's smallcase auth token

launch smallplug on a specific route (docs)

    SmallplugData smallplugData = new SmallplugData();
    smallplugData.targetEndpoint = "details/<relevant iscid from webhook payload>";
    smallplugData.params = ""
    ScgatewayFlutterPlugin.launchSmallplug(smallplugData)