To add the launcher code to your site, use the following steps:
- Add the launcher code to your page.
<script async src="https://launcher.spot.im/spot/SPOT_ID" data-spotim-module="spotim-launcher" data-post-url="ARTICLE_URL" data-article-tags="ARTICLE_TOPIC1, ARTICLE_TOPIC2" data-post-id="POST_ID"> </script>
- Replace the
SPOT_IDplaceholder with your Spot ID.
Your Spot ID is your unique OpenWeb identifier. When you log into your OpenWeb Admin Portal, you can copy your Spot ID from the URL:
- Define the URL of the page (data-post-url).
- Define the topics of the article (data-article-tags).
- Define the article identifier (data-post-id).
To learn how to best configure the launcher code, refer to the implementation documentation for the OpenWeb product, such as Conversation, Popular in the Community, Community Spotlight, and Reactions.
Depending on the product or feature you want to add to your site, you can add attributes to the launcher code that enhance the experience for your users. The following sections list and describe product-related launcher code attributes.
|data-article-tags ||Main topics of the article|
Multiple topics can be added by delimiting with a comma. The values of this attribute should usually align with the
|data-post-id ||Unique article identifier that is specific to the article page|
• Aligns with the URL slug (
• Is less than 50 characters, ideally 15 characters
• Uses a combination of letters, number, dashes (-), or hyphens (_)
• Except for the regex
|data-post-url ||Full URL address of the page in which the launcher code is embedded|
NOTE: This attribute must match the actual URL of the page where the launcher code is embedded, even if that page has a different canonical URL. For example, a news aggregator that uses canonical URLs to mark the original source of an article, must still use the reprint’s actual URL for this attribute.
|data-spotim-autorun ||Automatically loads OpenWeb products that have been enabled on an account and for which no |
In the location that the launcher code has been placed on the page, products are loaded in the following order:
2. Popular in the Community (Vertical | Horizontal)
3. Community Spotlight or Topic Tracker
5. Popular in the Community (Double-Decker)
To limit the automatic loading of enabled products (for example when implementing site-wide notifications), this attribute must be set to
The default value is
|data-theme ||On a specific page, sets the theme of the product|
To set the background for all products site-wide, use the Admin Panel.
|data-custom-CUSTOMPARAM ||Custom reporting parameter for a specific pageview or page type|
This is useful to provide additional granularity to data exports and BI reports. When using this attribute, replace
The attributes are taken from the first launcher script element found on the page. Subsequent Launcher script elements are ignored.
|data-author-id ||Controls the display of an Author Badge next to the author's name|
|data-messages-count ||Controls the initial number of displayed messages in Conversation|
|data-post-staleness-days ||Controls the number of days after which the post becomes read-only|
|data-read-only ||Controls if additional comments could be added to an article|
This attribute must be set to
|data-sort-by ||Controls the sorting for an article, overriding the default sort setting of the site|
|data-live-event-code ||Live Blog event code generated in your Admin Dashboard|
|data-live-blog ||Enables Live Blog on the conversation|
|data-recommendable-post ||Allows excluding a specific Conversation from being recommended for recirculation. |
|data-disqus-identifier ||disqus_identifier parameter in your Disqus integration code|
This identifier typically has a pattern of postID
|data-disqus-url ||disqus_url or this.page.url parameter in your Disqus integration code|
|data-facebook-url ||Canonical URL of the Conversation page|
Updated about 15 hours ago