Tenant Preference
Learn how to manage preferences for your tenants and its users
Tenants represents a segment that user belongs to. It can be organizations, teams within an organization, subsidiary companies or different product lines in the same business. If you're a B2B application or a multi-tenant SaaS product, you can use tenant preferences to allow company admins to set preference for their internal team or allow your customers to set default preferences for their users.
Company setting preference for tenants
In a multi-tenant architecture, businesses can define which notification categories and channels are applicable to different tenants. For example - if you are a SAAS platform with some paid features and some of your clients have not subscribed to the paid features. You can hide notification categories related to the paid feature for those tenants.
You can disable category overall preference or set channels as opt-out that are not valid for your tenants from tenant details page on SuprSend dashboard. Tenant will not be able to set preferences in the hidden categories and notification will not be sent to tenant's users in hidden categories.
Per-tenant default preference
Tenants can set default preferences for their end users and hide the categories which are not applicable to their end user. This gives tenants control to choose which notifications are sent to their users or shown to their users for setting preferences.
Controlling preference UI for users
Turning off categories or channels on tenant from tenant preference page automatically removes it from user's preference view. Additionally, if tenants wish to further limit the categories visible to their end users, they can do so by setting visible_to_subscriber
to false
in the default tenant preferences.
Collecting preference from tenant users
You can load user preferences for a tenant by simply passing tenant_id
in Rest APIs and preference centre SDK. Hosted preference page automatically loads preferences corresponding to the tenant passed in workflow trigger.
Triggering tenant workflows
You can simply trigger tenant workflow by passing tenant_id
in your workflow trigger. Read more about tenant workflows here.
Tenant level preference evaluation
When a workflow is triggered, preference is evaluated for recipient and tenant before send node. Notification is sent in categories and channels where both tenant and user preferences are opt_in
.
Evaluating Recipient preferences
If recipient preferences are not set in a category, default tenant preference is picked. Once user preference is set in a category, any changes in the default preference of existing categories will not effect recipient preferences.
Resolving preference conflicts
The order of precedence is always user > tenant > org (set in notification category settings). However, if company turns off notifications in a category or channel for a tenant, user will not get notification in that category even if they have kept their preference ON
in that category in the past.
Debugging preference evaluation in workflow runs
User preferences can change over time and when checking a workflow run, you need to know what was user's preferences at that time. You can view this using the step-by-step debugger in workflow executions.
You can also track when user updated their preference by filtering on Subscriber preference update
in request logs.
Updated 3 months ago
Add Preference Page in your application