How can we help? ๐Ÿ‘‹

Setting up Slack notifications

Learn how to set up Slack notifications to get notified about events from your knowledge base

You can receive messages in Slack whenever events in your knowledge base such as new article feedback gets triggered. To setup Slack alerts all you need is to provide HelpKit with your Slack webhook URL.

ย 
Notion image

1. Create an app in Slack

Go to theย Slack developer dashboardย and create a new app for your workspace. Select From an app manifest and paste the following text into the YAML editor:

ย 
Copy and paste this YAML code into your Slack app manifest
display_information:
  name: HelpKit Notifications
  description: Alerts from your HelpKit project
  background_color: "#6a29e3"
features:
  bot_user:
    display_name: HelpKit Notifications
    always_online: true
oauth_config:
  scopes:
    bot:
      - incoming-webhook
settings:
  org_deploy_enabled: false
  socket_mode_enabled: false
  token_rotation_enabled: false
ย 

This code will automatically setup the HelpKit Slack app for you. You can read more about the Slack app manifest here if your are curious.

ย 
Notion image

2. Create a webhook in Slack

Go to the Incoming Webhooks page for your newly-created app and make sure Activate Incoming Webhooks is toggled on.

ย 
Notion image
ย 

Then click on Add New Webhook to Workspace and select the channel that the alerts will be sent to. Lastly copy the new Webhook URL to your clipboard.

ย 
Notion image
ย 

If you want you can freely customize your Slack app looks and add the HelpKit logo as the Slack app icon. Download the HelpKit logo from here.

ย 

3. Connect your webhook to HelpKit

Navigate to your HelpKit dashboard. Under Settings/Alerts first toggle on Enable Alerts. You can always disable alerts here as well. Next, paste your Slack webhook URL from your clipboard into the corresponding field and click Send Test Alert. Open Slack and check if the test alert has successfully arrived in your channel. Lastly, hit the save settings button.

ย 
Notion image
ย 

Currently available knowledge base events

At the current moment, HelpKit will send a new alert to your Slack channel for the following events:

  • New help article reaction vote
  • New help article feedback comment
ย 
ย 
Did this answer your question?
๐Ÿ˜ž
๐Ÿ˜
๐Ÿคฉ