Skip to content

Before you start#

Check what you need, then choose how to install the Web SDK. Use this page if you are adding Storyteller to a website for the first time.

You need:

  • A Storyteller API key. The key identifies your tenant: your organization's Storyteller account and its content. Ask your Storyteller contact for a key, or get in touch.
  • Published content in the same tenant: at least one Story, or a Clips collection with published Clips.
  • An element on your page, such as a <div>, where the SDK can render a view.
  • To open the linked code examples, a GitHub account with access to the Storyteller Web Showcase source.

The examples use these placeholders. Replace them with your own values:

  • demo-api-key: your API key
  • your-user-id: the ID your site uses for the signed-in user
  • category-id: the ID of a Story Category
  • collection-id: the ID of a Clips collection

Choose an installation path#

Choose the guide that matches how your site builds its JavaScript:

Access the Storyteller Web Showcase source#

The Storyteller Web Showcase is a Next.js app that uses the Web SDK. Many guides link to its source code on GitHub. The repository is private.

To open the Showcase links:

  1. Tell your Storyteller contact which GitHub account you want to use, and ask them to give that account access.
  2. Accept the GitHub invitation.
  3. Sign in to GitHub with that account before you open a link.

Until your account has access, Showcase links return a 404 error. If a link still returns 404, check that you accepted the invitation and that you are signed in with the account that has access. If you still can't open the source, contact [email protected].

Resources

Next steps#