deploy-to-slack.md

description
How to set up slack

Deploy to Slack

Contact us for help setting up a bot for your enterprise and integrating it into your platform. Mentioned below are the instructions for the Slack Integration.

{% embed url="https://www.loom.com/share/210c5a724f474de58153e02f222d7a3f?sid=80cf5bf5-6d14-4a60-b6c7-a272f535f784" %}

Terminology

• Integrations - These are options on the Integration Page (specific whatsapp numbers, specific Slack Workspace channels) that a Copilot run/example can be connected to.
• Personal Channels - These are private channels that the bot creates for each user in a channel it is connected to so they can converse privately with the bot.
• Single Channel Members - This is a Slack feature that allows you to add members to your Slack workspace with limited permissions to one channel. Slack integration cannot create personal channels for these users as the Slack permissions forbid it.

Adding the Copilot Bot to a Slack Workspace

Once you have created a Copilot run/example, you can go to the Integration Tab (make sure your run/example id is in the url) and add your bot to WhatsApp, Slack, Facebook, any website with Landbot, and more.

{% hint style="info" %} Slack integration currently does not support channels with single channel members, since personal channels can’t be created for these. {% endhint %}

1. First you select an example or run (by clicking 'Tweak' or hitting 'Submit' to save your current settings), then go to the integrations page and click "Add Your Slack Workspace".
   
2. This will take you to a page where you select the workspace (upper right corner) and which channel to import (bottom centre) as an integration option into Gooey.AI. Both public and private channels work, however your own active user has to be a member of the private channel for the integration to work if the channel is not public. Otherwise, you can’t grant the bot access rights to this channel.
   
3. Upon clicking “Allow”, you should see a message confirming it was successful (you will be prompted to login to Gooey.AI first if you are not already logged in).
4. You can then go back to the integration page and after refreshing, the channel integration option should be visible:
   
5. Click "Connect" to connect your run or example (make sure a run or example is selected by verifying their respective ID is in the URL). Subsequently, your selected channel will receive the following confirmation message:

6. Send any message (text or audio) in this channel and the bot will respond in the relevant thread. The bot keeps track of a separate message history for each user (on a per-channel basis) to respond in context.
   \

7. You can also chat with the bot with a separate (private) conversation history in the personal channel that it created with all members when connected (it'll create new personal channels for newly joining members as well):
   

8. You can always remove the bot or change its display configuration by choosing it in the App pane on the left in your Slack workspace (see next section for details):
   

9. To change the data your chatbot uses, any of its other functionality parameters, or the name it posts as in each channel, you need to go to the Gooey.AI website (see next sections for Slack specific details and refer to the other Copilot Guides for general settings).

Adding the Bot in Multiple Languages

{% hint style="info" %} For now the integration specific language can only be configured by us, so contact us and we'll get language support set up for your integration. {% endhint %}

1. Create a channel for each language in your Slack Workspace
2. Create a run for each language by setting the user language to the corresponding language code using the settings dropdown on the run tab:
   
3. Hit submit after selecting each language to save a run with this language setting.
4. Follow the steps in the previous section for adding the run to your Workspace on the channel you created for it.
5. The bot should send a confirmation message in the respective channels when added which will let you know that the language was correctly configured.

Configuring the Slack App/Bot

Change the App Name

This is the name that appears in the Slack Workspace’s “Apps” list and in the initial message of the Bot Integration.

1. Open the app details by right clicking the app in the Apps list on the left bar:

2. Click "Configuration":

3. Scroll down to "Bot User" and click "Edit":

4. You can now enter any name for the App which will appear in the Apps list just like the screenshot in step 1. The changes usually reflect immediately but sometimes may take a few hours till Slack updates their cache.

Change the Channel Specific Bot Name

This is the name the bot replies as in the specific channel it has been integrated to. By default it is the Workspace name and the channel name.

We can change this directly in our database upon request or you can follow the below instructions to change it yourself.

{% hint style="info" %} The change will take effect immediately on all new messages and won't affect past messages. {% endhint %}

1. Log into Gooey.AI with the account that added the bot integration to your Slack workspace.
2. Go to the Copilot Recipe Integration Tab, find your integration and expand the “Slack Settings” by clicking on them:
   
3. Change the name and click “Update”.
4. If you refresh the page, the name should have changed.

Change the read receipt message

{% hint style="info" %} The change will take effect immediately on all new messages. {% endhint %}

1. Log in to Gooey.AI with the account that added the bot integration to your Slack workspace.
2. Go to the Copilot Recipe Integration Tab, find your integration and expand the “Slack Settings” by clicking on them:
   
3. Change the read receipt message and click “Update”.
4. If you refresh the page, the receipt text should have changed.

Remove the Bot

1. In the left bar, find and right-click the app in the Apps list and select 'View app details':
   
2. Click "Configuration":
   
3. Scroll down to "Remove App" and click "Remove App":
   

{% hint style="info" %} Once you’ve removed the copilot app from your workspace, if you ever want to add it or another copilot bot back, you’ll need to click “Add to Workspace” on the integrations page again even though the integration/channel seems to appear in the integrations list. Follow instructions here: Adding the Copilot Bot to a Slack Workspace. {% endhint %}

Siri Integration

We have experimental Siri support through IOS shortcuts. This will allow you to chat back and forth with any Slack copilot integration verbally via Siri and import conversations into Slack for details.

Install Siri Integration

1. Install the Siri Shortcut by clicking the link on an iPhone (Mac and iPad are not tested).
2. Activate the Shortcut by clicking on it or by telling Siri “Start copilot” verbally.
3. The first time, you’ll need to give the shortcut multiple permissions (select “Always allow” on all these to not be prompted again). You will also need to login to your Slack Workspace which requires knowing its URL. This can be found by opening your Slack Workspace and clicking on its icon in the upper left corner. It should be right under the name (in this example it is “gooeyai.slack.com”):
   
4. For convenience, you can now add the shortcut to the home screen, lock screen or (iPhone 15+) assign it to your action button. Activating with Siri directly will always work too.

Add to Home Screen

1. Open your “Shortcuts” app:
   
2. Identify the copilot shortcut (top left orange box in below screenshot):
   
3. Hold down on it to open the context menu:
   
4. Select “Information” (3rd option) from the context menu:
   
5. Top option will add the shortcut to the home screen.

Add to Lock Screen

1. Unlock your iPhone and tap and hold on to the lock screen to go into editing mode.
   
2. Tap the “Customize” button and choose the “Lock Screen” option.
   
3. Tap on “Add Widgets” and scroll down to pick Shortcuts.
   
4. Tap on the widget to add it to the lock screen. Tap the widget in the widget area to customize it.
   
5. Select the “Copilot” shortcut.
   
6. Tap the cross button and then the “Done” button to save changes.
   
7. The shortcut will now show up on the lock screen and can be clicked.
   

Notes

• The bot currently responds to Slack Audio, regular text messages and video messages.
• The bot can respond with text, audio, and/or video if you select those options in the run settings. Check the other Copilot Guides.
• Don’t try to reset your message history at this point. This is handled automatically by the chatbot logic. Resetting manually will result in all feedback being lost.

Changelog

v0.0.1 - 8/7/2023 PST

• Basic add integration functionality on gooey.ai/copilot/integrations
• Respond to text and audio
• Custom name for each channel, can only be edited in db
• Reply with text
• Supports collecting feedback

v1.0.0 - 8/8/2023 PST

• Works for private channels
• The bot can send back audio and video messages
• Adding the bot to a Slack workspace has been simplified (no need to @invite it if the user is a member of the channel already)
• Reconnect to make the botname match the title of the run/example
• Adding the bot again overwrites so deletion is fine
• To use the new features, the App must be readded to Slack

v1.1.0 - 8/14/2023 PST

• Added read receipts
• The read receipt message can be configured on the integration page

v1.2.0 - 8/19/2023 PST [Actively Deployed]

• Personal channels for private conversations (these have separate conversation histories and messages happen top level instead of in replies)
• Easier channel specific name change
• Better display name in integration page (includes channel and workspace)
• Supports video messages
• To use the new features, the App must be readded to Slack