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 dashboard to add the token.

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 dashboard. When you add the integration, you will get the Full URL.

  1. Click on the Save Integration button.

Now you can search through your documents directly from Slack. Just type #qq followed by your query.