Custom AI Bot Agent Integration On Slack

Tutorial series

1. Getting Started with Workik AI Bots

Welcome to the quick start guide for integrating the Workik AI Bot with your Slack workspace! This guide will help you bring Workik's AI capabilities into your Slack conversations, enabling you to automate tasks and get instant answers to your queries directly within Slack. Let's dive in and boost your productivity!

Requirements:

Before we start the integration process, ensure you have:

Workik Account: Don't have an account yet? No worries, creating one is quick and easy! We'll guide you through setting up your Workik AI Bot account in the following section.

2. Setting Up Bots in Workik

Before integrating Workik AI Bot with your Slack workspace, ensure your bot is properly set up in Workik. This section is crucial for those who haven't configured their bot's context yet. If your bot is already configured, you may skip to the Integration Process section (next section).

A. How to Configure Custom AI Bots in Workik

Start by logging into your Workik dashboard or sign up to Workik if you haven’t already. Go to the ‘AI Bots’ section and click on “Create New Bot” to start the bot creation and configuration process.

B. Steps to Create AI Bot Agents:

Upon initiating bot creation, a pop-up appears. Follow the steps outlined to configure the bot

Enter the bot details
First Name Your Bot. Give it a descriptive name that reflects its specialisation, like "backend", "frontend", “database”, etc. Next, in Bot System Description, clearly articulate what the bot is designed to do.

Add your Context

This is where you tailor the bot's knowledge base. To do that, you can select from any of the relevant context options like: Text Input, Options List, Code, Database, Image or RestAPIs. You can also pull context from any of the preset environments on Workik. After adding all the relevant context, select the context that the bot needs to be trained on.

Note: Environments contain the context that you add on Workik. Workik allows users to add diverse types of context related to your tech stack such as: Programming languages, libraries, code files, coding standards, database schemas for SQL or NoSQL systems, import API blueprints from Postman, image resources for UI design, and more. Additionally, you can integrate with version control platforms such as GitHub, GitLab, or Bitbucket. Please click here to know more about adding context.

Configure Bot Settings

Tweaking " Settings" customises the bot's interaction style, but they can be left as is for standard behaviour.

AI Model: You can choose any preferred model for generating AI responses (We currently support OpenAI, Gemini, and Claude)
Temperature: Adjust how creative or predictable bot responses should be.
Max Tokens: Set the length of the bot's responses.
Frequency Penalty: Control the bot's tendency to repeat information.
Presence Penalty: Determine how often the bot should introduce new concepts.

Click on Create

Finally click on create and your bot is ready to be integrated.

Once your bot is created and configured, you're ready to integrate it with Slack.

3. Integrating Custom Workik AI Bots with Slack

Follow these steps to have your Workik AI bots up and running in your Slack workspace.

Step 1: Initiate Slack Connection

Click on your bot and select the option to ‘Add to Slack’.

Step 2: Authorise on Slack

You will be redirected to Slack’s sign-in page. Enter your Slack workspace URL and sign in to your Slack account.

Step 3: Grant Necessary Permissions

Workik will request permission to access your Slack workspace.Review the permissions and click 'Allow' to grant Workik the necessary access.

Step 4: Confirm Bot Configuration

Verify the successful integration with a confirmation message in Workik and ensure all bot settings are correct.

4. How to Use AI bots in Slack:

To tap into the assistance of Workik AI within Slack, start by adding the bot to the specific channel or group where you need its assistance.

Add Workik AI Bot to Your Channel

Before you begin chatting, make sure the Workik AI bot is part of the conversation:

Add to a Channel: In your Slack channel, select the channel, type ‘/invite’ and click on 'Add apps to this channel'.

Search for Workik: Find the Workik bot in the Slack directory and add it to your channel.

To Chat with a Specific Bot:

There are two ways to initiate conversation with the bot:

Using slash Command (/bot ): Type /bot [botname] [your question].
- Example: /bot Backend How do I fix a 500 server error?
Using direct mention (@Workik-bot): Mention both @Workik-bot and the bot's name: @Workik-bot @BackendBot [your question].
- Example: @Workik-bot @Backend What’s the best caching strategy for our setup?

Discover Bots:

Type /bots-list to view all the bots available to assist you in your Slack workspace.

There you have it—simple and efficient! Whenever you're ready, let's take your Slack experience to the next level.

5. Troubleshooting

Encountered a hiccup with Workik AI Bots in Slack? Here's how to resolve some common issues you might face:

Bot Not Responding

Check Bot Presence: Ensure the bot is added to the channel. If not, add the bot by going to the channel details and selecting 'Add apps'.
Verify Permissions: Confirm that Workik AI has the necessary permissions in Slack. If in doubt, revisit the authorization steps to ensure everything is set up correctly.

Bot Not Understanding Queries

Simplify Your Questions: Try breaking down your questions into simpler terms.
Provide Context: Make sure you've added relevant context in Workik that the bot can use to understand and answer your questions.

Commands Not Working

Check Syntax: Revisit the command syntax to ensure it’s entered correctly, like /bot backend [question].
Review Slack's Command List: If custom slash commands are conflicting, review your Slack settings to troubleshoot overlaps.

Integration Issues

Re-authenticate: If the bot isn't integrating properly, disconnect and reconnect Workik AI in your Slack workspace settings.
Update Workik: Ensure you’re using the latest version of Workik AI for optimal functionality.

For any persisting issues, consult the detailed documentation on Workik, or reach out to the support team at support@workik.com for assistance. Your smooth workflow is our priority!