Skip to main content
QuikQuery can be integrated with Slack to allow your team to search through your documents directly from Slack. To integrate QuikQuery with Slack, you need to follow these steps:

​
Create a Slack App

  1. Go to Slack Apps and click on the Create New App button.
  1. Click on the From a manifest link.
  2. Select the workspace where you want to install the app. And click on the Next button.
  1. Copy and paste the following manifest:
{
  "_metadata": {
    "major_version": 1,
    "minor_version": 1
  },
  "display_information": {
    "name": "QuikQuery chatbot"
  },
  "features": {
    "app_home": {
      "home_tab_enabled": true,
      "messages_tab_enabled": false,
      "messages_tab_read_only_enabled": true
    },
    "bot_user": {
      "display_name": "QuikQuery chatbot",
      "always_online": true
    }
  },
  "oauth_config": {
    "scopes": {
      "bot": [
        "app_mentions:read",
        "channels:join",
        "channels:history",
        "channels:read",
        "chat:write",
        "im:history",
        "im:write",
        "groups:history",
        "groups:write",
        "groups:read",
        "team:read",
        "channels:manage"
      ]
    }
  },
  "settings": {
    "event_subscriptions": {
      "bot_events": ["app_home_opened", "message.channels", "message.im"]
    },
    "interactivity": {
      "is_enabled": true
    },
    "org_deploy_enabled": false,
    "socket_mode_enabled": true,
    "token_rotation_enabled": false
  }
}
  1. Click on the Next button.
  2. Click on the Create button.
Great job! You have successfully created a new Slack app. You see the Basic Information page of your app.

​
Add oAuth & Permissions

  1. Go to the OAuth & Permissions section and click on the Install to Workspace button.
  1. Click on the Allow button.
  1. Copy the OAuth Token and return to the QuikQuery apps side to add the token.

​
Configure QuikQuery App

  1. Navigate to the QuikQuery apps page
  1. Select your desired bot from the list
  2. Click on the Slack app details to view an overview of the integration
  3. Navigate to the settings tab
  1. Click “Add workspace” or “Connect your first workspace”
  2. Enter your workspace details:
    • Workspace name
    • OAuth token (from Slack OAuth & Permissions page)
    • Select your QuikQuery Token
  1. Click “Add workspace” to save your configuration
  2. Once saved, you’ll see your Slack app listed in the workspace list
  1. Copy the Webhook URL from your app for the next configuration step

​
Add Outgoing Webhook

  1. Go to Outgoing Webhooks
  2. On the top right corner, make sure you are in the correct workspace. (The same workspace where you installed the app)
  1. Click on the Add To Slack button.
  2. Click on the Add Outgoing Webhook Integration button.
  1. Fill in the following details:
  • Channel: #Any
  • Trigger Word(s): #qq
  • URL(s): https://www.quikquery.io/api/v1/slack?token=${token}&botId=${botId}
The URL is generating from the QuikQuery Apps On Configure QuikQuery App step
  1. Click on the Save Integration button.
  2. Return to the QuikQuery Slack apps page and on your app click on the “Connect to Slack Workspace” button to complete the integration.
Now you can search through your documents directly from Slack. Just type #qq followed by your query.