teem

Runs on teem

updated

Open the widget from your own button

Call teem.open() from any link or button in your app to land people in chat, feedback, the Help Center or one article.

The launcher in the corner always works. If your app already has a Help menu or a "Send feedback" link, point it at the widget so people land in the right place.

teem.open("chat")      // ask the team a question
teem.open("feedback")  // the request list, to vote or post
teem.open("help")      // your Help Center
teem.open()            // the widget's home screen
teem.close()           // close it again

To open one Help Center article, pass its id. It starts with ha_, and you'll find it in the article's address in your dashboard.

teem.open("help", { article: "ha_..." })

Wiring it to a link

document.querySelector("#feedback-link").addEventListener("click", (event) => {
  event.preventDefault()
  teem.open("feedback")
})

Things to know

  • window.teem exists once the script has run. The tag loads with defer, so call it from a click handler or after the page has loaded, not from a script at the top of the page.
  • teem.open() throws an error for anything other than home, chat, feedback or help, so a typo shows up in your console.
  • If the widget is already open, teem.open() switches it to the view you asked for.
  • The launcher stays on screen. There's no setting to hide it yet.
  • Bug reports start from Report a bug on the widget's home screen. There's no call that opens one directly.

If nothing happens

Open your browser console. teem is not defined means the script hasn't loaded yet, or isn't on the page. The widget doesn't show up walks through the rest.

Still need help?

Open the widget and send the team your question.