The OpenWeb Developer Hub

Welcome to the OpenWeb developer hub. You'll find comprehensive guides and documentation to help you start working with OpenWeb as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Documentation

Topic Tracker

Enable users to follow their favorite topics and authors and receive timely notifications when relevant content is published.

Topic Tracker allows users to follow their favorite topics and authors and to receive timely notifications when relevant content is published. When embedded on a page, this interactive widget drives user retention and increases the time your users spend on your site.

Topic Tracker's subscription widgetTopic Tracker's subscription widget

Topic Tracker's subscription widget



Requirement

Page-level metadata: This metadata is used to populate the interactive widget and trigger notifications.
The following table lists the page-level metadata sources that are compatible with Topic Tracker:

Source Values
LD-JSON Schema Attributes:
•   author
•   keywords
Open Graph Properties:
•   author
•   tag
Standard Metadata Name:
•   author
•   keywords

📘

TIP

If your pages are not uniquely tagged or you plan to execute a custom experience, you can set metadata at the launcher code or Topic Tracker embed code level.

  • Launcher code: To override the page-level topics, add the topics to the data-article-tags attribute of the launcher code.

  • Topic Tracker embed code: To override page-level and Launcher code-level topic and author metadata, add the data-keywords and data-authors attributes to the Topic Tracker embed code. These attributes apply only to the content displayed in Topic Tracker and will not be used to trigger notifications.



Implementation

You can add Topic Tracker to a page using either the Standard or Custom Location method.

Standard

When using this implementation method, Topic Tracker appears where the launcher code is located. If Conversation is enabled, Topic Tracker appears horizontally above it.

To add Topic Tracker, use the following steps:

  1. In your OpenWeb Admin Panel, click Features > Topic Tracker.
  2. Under Enable/Disable Topic Tracker, click the toggle to Enabled. Additional Topic Tracker settings appear.
  3. From the Choose Location dropdown menu, choose Above Conversation.
  4. Click Save & Publish.

Custom Location

When using this implementation method, you can choose the location in which Topic Tracker appears on a page.

To add Topic Tracker, use the following steps:

  1. In your OpenWeb Admin Panel, click Features > Topic Tracker.
  2. Under Enable/Disable Topic Tracker, click the toggle to Enabled. Additional Topic Tracker settings appear.
  3. From the Choose Location dropdown menu, choose Custom location (horizontal orientation) or Sidebar (vertical orientation).
  4. Copy the Embed Code.
ApproachCode
Custom location <div data-spotim-module="topic-tracker" data-post-id="POST_ID"></div>
Sidebar*<div data-spotim-module="topic-tracker" data-post-id="POST_ID" data-vertical-view="true"></div>

* The Sidebar implementation of Topic Tracker requires a minimum width of 300px.

📘

TIP

You can override the default page-level SEO metadata by adding the following attributes to the embed code:

Topic: data-keywords="Topic1,Topic2,Topic3"
Author: data-authors="Author1,Author2"

These attributes apply only to the content displayed in Topic Tracker and will not be used to trigger notifications.


  1. Click Save & Publish.
  2. On your page, add the Topic Tracker embed code in the desired page location.
  3. When embedding Topic Tracker on a page without other OpenWeb products, add the launcher code.

Updated 3 days ago


Next Step

Add a notification bell to a prominent location so users can easily notice when a new relevant article was published

Notification Bell

Topic Tracker


Enable users to follow their favorite topics and authors and receive timely notifications when relevant content is published.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.