Notifications
Context¶
InvestSuite offers a standard set of push or in-app notifications.
Below you can find a detailed list of the notifications InvestSuite offers.
How are notifications delivered?¶
Robo Advisor¶
Standalone application | SDK (add-to-app) | |
---|---|---|
Responsible | InvestSuite sends out push notifications | Client is responsible for sending out push notifications |
Integration pattern | No integrations are needed. | InvestSuite delivers the type of the notification on a message bus (kafka, rabbitMQ...). |
Self investor¶
Under construction
Supported notifications¶
Robo Advisor¶
Overview¶
Notification | ID | Description | Relevant for standalone app | Relevant for SDK |
---|---|---|---|---|
First-time cash received in a portfolio | FIRST_TIME_CASH_RECEIVED |
Sent to the user when a particular portfolio is first funded with cash and that cash is received in that portfolio. (min amount is reached) | Yes | No (in case of instant funding) |
First-time assets purchased in a portfolio | FIRST_TIME_ASSETS_PURCHASED |
Sent to the user when a portfolio is first invested. | Yes | Yes |
New cash received which will be invested soon | CASH_RECEIVED |
This is after the portfolio is topped up with more cash. This can be another lump sum, or a monthly investment. | Yes | No (in case of instant funding) |
Portfolio rebalanced because of newly added cash | ASSETS_PURCHASED |
After cash has been received (and the pop-up directly above is sent) we will let the user know once his portfolio has been rebalanced with new assets being purchased. | Yes | Yes |
Assets sold to generate cash for a withdrawal instruction | ASSETS_SOLD |
Sent to users after assets have been sold following a withdrawal instruction to let them know that their portfolio has changed. | Yes | Yes |
Cash sent to your bank account | CASH_SENT |
Sent following the notification directly above, once that money has been sent by the app to the users bank account. (triggered by events/withdraw endpoint in investsuite api) | Yes | Yes |
Portfolio allocation change to get portfolio back in line with constraints | REBALANCE_OUT_OF_BOUNDS |
“out of bounds” rebalance, to keep it in line with constraints (eg: risk profile) | Yes | Yes |
The user’s portfolio has been activated at the side of the Broker/Custodian | PORTFOLIO_ACTIVATED |
Account has been created at the side of the broker/custodian | Yes | Yes (if broker integration) |
Example¶
{
"_type":"REBALANCE_OUT_OF_BOUNDS",
"portfolio":{
"id":"{ivs-portfolio-id}",
"name":"{portfolio-name}"
},
"details":{
"id":242,
"userId":"{ivs-user-id}",
"tenant":"{tenant}",
"namespace":"{value}",
"module":"ROBO",
"timestamp":1709716246011
}
}
Field | Type | Content |
---|---|---|
_type | string | type of notification |
portfolio.id | string | InvestSuite portfolio id |
portfolio.name | string | Portfolio name as set by user and known in InvestSuite |
details.id | string | notification id |
details.userId | string | InvestSuite user id |
details.tenant | string | fixed value referring to the tenant |
details.namespace | string | fixed value, can be ignored |
details.timestamp | timestamp | timestamp when the notification was created |
Self investor¶
Under construction