Documentation

Getting started

  1. 1

    Login

    Sign up and log in to talksprout. You can sign in using one of the identity providers shown or log in via email using passwordless authentication.

  2. 2

    Create a workspace

    Once logged in you'll be presented with the dashboard. This is where all of your workspaces can be accessed, along with various actions. A single workspace groups all the feedback from one widget. Click the Create workspace button to start configuring your widget. You'll be asked to choose a widget type: Sentiment (emoji ratings 1–5 with open text), CSAT (thumbs up / down satisfaction score), or NPS (0–10 likelihood to recommend).

  3. 3

    Customise the widget

    Give your workspace a name to identify it, e.g. your product name or a specific page. You can also customise the prompt message, select a primary accent colour, and remove the talksprout branding. Sentiment workspaces additionally let you choose an emoji set. Certain options are only available on paid plans.

  4. 4

    Integrate the widget

    The first workspace you ever create walks you through this step automatically. For any workspace after that, open Install from the workspace's own page (or its settings) to get the snippet again at any time. The script URL depends on the widget type you chose. Embed it into the <head> of your HTML page:

    Sentiment

    1 <script type="module" src="https://www.static.talksprout.com/js/ts.js"></script>

    CSAT

    1 <script type="module" src="https://www.static.talksprout.com/js/csat.js"></script>

    NPS

    1 <script type="module" src="https://www.static.talksprout.com/js/nps.js"></script>

    Then add an HTML trigger element with the workspace ID attribute. Use [data-talksprout] for Sentiment, [data-talksprout-csat] for CSAT, or [data-talksprout-nps] for NPS. The widget anchors to the trigger element, we recommend a button.

    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 <body> <!-- Sentiment widget --> <button data-talksprout data-talksprout-workspace-id="YOUR_WORKSPACE_ID" data-talksprout-user="" > Your button </button> <!-- CSAT widget --> <button data-talksprout-csat data-talksprout-workspace-id="YOUR_WORKSPACE_ID" data-talksprout-user="" > Your button </button> <!-- NPS widget --> <button data-talksprout-nps data-talksprout-workspace-id="YOUR_WORKSPACE_ID" data-talksprout-user="" > Your button </button> </body>
  5. 5

    Access your feedback

    Once integrated, send a test submission to verify installation. You can then access feedback by navigating to your workspace through the dashboard. Submissions will appear immediately.