Installing the Slack Integration

by Jake Peters

The HelpDocs Slack integration helps you get your whole team involved in making your knowledge base successful for your customers and team. You can view it on the Slack store here.

Here's what you can do once it's installed on your workspace:

  1. Create new docs and draft up notes within Slack
  2. Search and insert docs in any channel
  3. Get an overview with team activity, visitor feedback, and submitted contact forms
Slack HelpDocs Integration

Setting Up the Slack Integration

Connecting your Team to Slack

Before you can start using the HelpDocs Slack integration you'll need to add our Slack app to your team.

If you already had Slack connected before the 31st January, please click here to upgrade your integration.
  1. In your HelpDocs dashboard, head to SettingsIntegrations
  2. In the Slack card, hit Add to Slack
  3. We'll redirect you to Slack to grant us access to your team
    1. Log into Slack if you aren't already logged in
    2. If you have multiple Slack teams, choose the one you want to connect to HelpDocs
    3. Review the permissions
      1. Incoming Webhooks let us post notifications in to a Slack channel of your choice. You can customize these later.
      2. Commands lets us add /commands to your team so you can interact with your docs
      3. Identity lets us identify your teammates so we can show the right docs to the right people
    4. Choose a channel for us to post notifications (incoming webhooks) to
  4. Click the Authorize button to return to HelpDocs

Connecting your User Account to Slack

You can connect your Slack and HelpDocs accounts in the HelpDocs dashboard manually. Or just follow the instructions the first time you use a /command.

If you were the user that originally connected your team's Slack account to HelpDocs, your user account will be linked automatically
  1. In HelpDocs, head to your Profile by clicking your avatar in the navigation bar
  2. Under Slack, click Sign In with Slack
  3. We'll redirect you to Slack
    1. Login to Slack if you aren't already logged in
    2. Choose the correct Slack team (if prompted)
  4. Click Authorize to return to HelpDocs

Now you can use /commands in Slack to create and search for articles. Your permissions there will mirror your HelpDocs permissions.

Disconnecting your Slack Account from HelpDocs

If you don't wanna use the Slack integration anymore you can easily revoke our access. I promise we won't take it personally 😢

  1. Head to your HelpDocs Profile by clicking your avatar in the navigation bar
  2. Under Slack, hit the link to revoke access
Once all users on your team have revoked access, we'll no longer have access to your Slack account to send webhooks, and we'll uninstall the /commands

What did you think of this doc?