Preferences Editor

Use the Preferences Editor to create and configure individual Subscription topics and Preference Sections.

​

Subscription Topics

Subscription Topics are categories of notifications that users can opt-in and out of. For example, welcome and onboarding notifications could be mapped to an Onboarding topic.

​

Configuration

You can set topic properties like Name, the Section it will be in, and its Default State.

​

Topic Data

For a subscription topic, you can provide arbitrary metadata to our API, which allow you to make custom Preferences pages. Use cases include allowing your custom preferences page to filter subscription topics or create custom experiences with your preference page.

• Filter subscription topics by metadata
• Create custom logic for controlling
• Maintaining custom topic descriptions

​

Default State

The Default State defines whether a topic can be opted in or out, and whether it’s always required.

• On - Users who do not take any action will automatically receive notifications in this grouping.

• Off - Users will not receive these notifications unless they change their preferences.

• Required - Users will not be able to opt-out of these notifications.

​

Preference Sections

Preference Sections group subscription topics together and determine which topic delivery channels users can opt in/out of.

​

Delivery Channel Selection

Delivery Channel Selection gives recipients the ability to select and set the preference for their preferred delivery channel from the Preferences Hosted page.

Channel selection must be enabled for the subscription topic in order for users to customize their delivery channel preferences.

​

Channel Delivery Customization & Preferences API

{
	"topic": {
		"custom_routing": [
			"email",
			"push",
			"webhook"
		],
		"has_custom_routing": true,
		"default_status": "OPTED_IN",
		"section_id": "5p8ROfompcN6Sg_2WR92A",
		"section_name": "Notifications",
		"status": "OPTED_IN",
		"topic_id": "FPPGTQRQTRM8TSPZGZAY9296WB37",
		"topic_name": "SMS"
	}
}

​

How to Map a Notification Template to a Subscription Topic

There are three ways to map a notification template to a subscription topic:

​

Topic Settings

In the Subscription Topic Settings, you can select one or more notification templates.

​

Template Creation

When creating a new notification, you can select a subscription topic.

​

Notification Settings

In the Notification Designer, you can select a subscription topic.