TellClue docs

  • Board Widget
  • SSO (single sign-on)

Board Widget

This quickstart will show you how to setup the SDK and get it to render the board widget on your site.

1. Include SDK

The following snippet of code will load and initialize the SDK. You should insert it at the place (inside the <body> tag) where you want to render the widget:

            
      <div id="tellClue-widget"></div>
      <script>
      !function(){var e=document.createElement("script");e.type="text/javascript",e.async=!0,e.src="https://tellclue.com/public/widgets/sdk.min.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t),window.tellclue||(window.tellclue={render:function(e){window.tellclueRenderQ=e}})}();
      </script>
                      

2. Trigger the widget rendering

In order to render widget you need to execute following code:

            
      window.tellclue.render({
        companySubdomain: 'YOUR_COMPANY_SUBDOMAIN',
        boardId: 'YOUR_BOARD_ID',
        basePath: 'PATH_OF_YOUR_SITE_PAGE',
        sso : 'SSO_TOKEN'
      });
                      
You can find YOUR_COMPANY_SUBDOMAIN and YOUR_BOARD_ID on the integration tab of you board

  • Replace YOUR_COMPANY_SUBDOMAIN with your company subdomain

  • Replace YOUR_BOARD_ID with id of the board you want to embed

  • Replace PATH_OF_YOUR_SITE_PAGE with path of the page where you embed widget. For example for http://mysite.com/feature_requests base path is /feature_requests. We use it to syncs the URLs between our widget and your site.

  • Replace SSO_TOKEN with sso token generated for your user. For detailed guide check Single sign-on integration


Note: you should setup routing on your site so /feature_requests and /feature_requests/* URLs points to the same page.



You can render widget immediately after page loading:

            
      <script>
          window.tellclue.render({
            companySubdomain: 'YOUR_COMPANY_SUBDOMAIN',
            boardId: 'YOUR_BOARD_ID',
            basePath: 'PATH_OF_YOUR_SITE_PAGE',
            sso : 'SSO_TOKEN'
          });
      </script>
                      

Or render it whenever you want:

            
      document.getElementById('#MY_BUTTON_ID').addEventListener('click', function () {
        window.tellclue.render({
          companySubdomain: 'YOUR_COMPANY_SUBDOMAIN',
          boardId: 'YOUR_BOARD_ID',
          basePath: 'PATH_OF_YOUR_SITE_PAGE',
          sso : 'SSO_TOKEN'
        });
      })