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    

Launcher code reference

OpenWeb's launcher codelauncher code - JavaScript code that loads the library and configurations for an OpenWeb product or feature is the JavaScript library that enables products and features on your pages.

<script 
    async 
    src="https://launcher.spot.im/spot/SPOT_ID"
    data-spotim-module="spotim-launcher">
</script>



Conversation

AttributeDescription
data-article-tags string
                                                                     
Main topics of the article

Multiple topics can be added by delimiting with a comma.
data-messages-count numberControls the number of displayed messages
data-post-id stringUnique article identifier that is specific to the article page

The ideal POST_ID has the following characteristics:

• Aligns with the URL slug (an-article-title) or article ID (14325)
• Is less than 50 characters, ideally 15 characters
• Uses a combination of letters, number, dashes (-), or hyphens (_)
• Except for the regex [^\w\s\-\:\.\$\~], does not include special characters
data-post-url stringFull URL address of the page in which Conversation is embedded

NOTE: If a page has both a third-party article and Conversation embedded, the value of this attribute should match the parent page in which Conversation is embedded.
data-read-only booleanControls if additional comments could be added to an article

This attribute must be set to true to disallow any additional comments or replies from being posted.
data-spotim-autorun booleanAutomatically loads OpenWeb products that have been enabled on an account and for which no <div> has been explicitly set

In the location that the launcher code has been placed on the page, products are loaded in the following order:

   1. Reactions
   2. Popular in the Community (Vertical | Horizontal)
   3. Community Spotlight
   4. Conversation
   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 false.

The default value is true.
data-spotim-multi-instance booleanEnable multiple Conversation instance in a single-page application

This attribute must set to true to enable this behavior.

The default value is false.
data-theme stringOn a specific page, sets the theme of the product

Possible values include the following:
   • light: (Default) Light OpenWeb theme. Use this theme for pages that have a light background. If using the default theme, this attribute does not need to be included in the launcher code.

   • dark: Dark OpenWeb theme. Use this theme for pages with a dark background

To set the background for all products site-wide, use the Admin Panel.



Live Blog

ParameterDescription
data-enable-live-blog-replies boolean
                                                                     
Enable replies on Live Blogs

Default: true
data-live-event-code stringLive Blog event code generated in your Admin Dashboard
data-live-blog booleanEnables Live Blog on the conversation

Default: false
data-reporters stringLive Blog reporters
data-theme stringOn a specific page, sets the theme of the product

Possible values include the following:
   • light: (Default) Light OpenWeb theme. Use this theme for pages that have a light background. If using the default theme, this attribute does not need to be included in the launcher code.

   • dark: Dark OpenWeb theme. Use this theme for pages with a dark background

To set the background for all products site-wide, use the Admin Panel.



Third-party comment importing

AttributeDescription
data-disqus-identifier string
                                                                     
disqus_identifier parameter in your Disqus integration code

This identifier typically has a pattern of postID https://admin.publisher.domain/?p=postID.
data-disqus-url stringdisqus_url or this.page.url parameter in your Disqus integration code
data-facebook-url stringCanonical URL of the Conversation page
data-livefyre-url stringarticleId that uniquely identifies a Collection in your Livefyre account

Updated 7 days ago


Launcher code reference


Suggested Edits are limited on API Reference Pages

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