Installation and Upgrades

Time to complete: ~5 minutes
Prerequisites: A Conveyor Admin to install, plus approval from a Slack Admin.


Overview

This page walks through installing the ConveyorAI app in Slack for the first time and re-authenticating it after new features ship. Installation must be done by a Conveyor Admin and requires approval from a Slack Admin.

Add to Slack

Set Up a New Installation

Follow these steps if your organization is setting up Slack for the first time. This must be done by a Conveyor Admin.

  1. In Conveyor, open Settings and go to Integrations (under Organization), then click Add Integration.
  1. In the Add an Integration dialog, select Slack, then click Next Step.
  2. On the Integration details step, optionally rename the integration, then click Authenticate. You'll be redirected to Slack to grant permissions — make sure the correct Slack Workspace is selected (use the dropdown to change it if the default is wrong).
  3. Review the scope of access and click Allow.

Once permissions are granted, ConveyorAI is installed, you'll see Conveyor under Apps in your Slack sidebar. Type /conveyor help in Slack to see the list of available commands:

The Add an Integration dialog in Conveyor with the Slack option highlighted, described as 'Allows your team members to receive notifications and generate answers using ConveyorAI in Slack.

Add an Integration, Choose Slack, then click Next Step.

The Add an Integration dialog in Conveyor with the Slack option highlighted, described as 'Allows your team members to receive notifications and generate answers using ConveyorAI in Slack.'

Name the integration and click Authenticate to grant permissions in Slack.

The Slack permissions screen listing the requested scopes with an Allow button.

Review the requested scopes and click Allow.


Re-authenticate After an Upgrade

When Conveyor ships new Slack features, integrations installed before that release need a quick re-authentication to pick them up. It only takes two clicks — you do not need to archive the integration.

  1. In Conveyor, open Settings → Integrations.
  2. Click the three dots next to your Slack integration, then click Update CredentialsAuthenticate.
💡

If your Slack organization requires approval for app installation, you'll need to request approval first, then repeat these steps once the app is approved.


Manage the ConveyorAI App in Slack

Anyone who can view the app's settings can review its permissions, rename the bot, or remove it — all from the app's page in Slack.

  1. In Slack, open the Conveyor app, select the About tab, and click Configuration.
  1. On the Configuration page you can review the app's Authorizations (its Slack permission scopes), rename the bot by clicking Edit under Bot User, or remove the app under Remove App.
  2. Within Configuration, you can rename the bot by navigating to Bot User, choosing "Edit" and the naming as desired.
The Conveyor app Configuration page in Slack, listing its authorizations, a Bot User section with an Edit button, and a Remove App section.

Permission Scopes

ConveyorAI can only access content in the channels and conversations it's been added to. When a Slack admin approves the app, these are the permissions it authorizes (Slack permission scopes):

ScopeWhat it allows
app_mentions:readView messages that directly mention @Conveyor in conversations the app is in
channels:readView basic information about public channels in a workspace
channels:historyView messages and other content in public channels ConveyorAI has been added to
groups:readView basic information about private channels ConveyorAI has been added to
im:readView basic information about direct messages ConveyorAI has been added to
im:historyView messages and other content in direct messages ConveyorAI has been added to
im:writeStart direct messages with people
chat:writeSend messages as @Conveyor
chat:write.publicSend messages to channels @Conveyor isn't a member of
commandsAdd shortcuts and/or slash commands that people can use
files:readView files shared in channels and conversations ConveyorAI has been added to
files:writeUpload, edit, and delete files as ConveyorAI
reactions:readView emoji reactions and their associated content in channels and conversations ConveyorAI has been added to
reactions:writeAdd and edit emoji reactions
users:readView people in a workspace
users:read.emailView email addresses of people in a workspace

Common Questions

Q: Who can install the integration?
A: A Conveyor Admin performs the installation, and a Slack Admin must approve it. The most common setup problem is trying to install without a Slack admin account.

Q: @Conveyor isn't responding after an upgrade — what do I do?
A: Re-authenticate the integration using the steps above. Features released after your original install won't work until you do.

Q: Can we change the bot's name?
A: Yes — a Slack admin can rename it from the app's Configuration page in Slack under the "Bot User" section. See Manage the ConveyorAI App in Slack.


What's Next?


Need help? The most common problem when setting up the integration is not using a Slack admin account. If issues persist, visit the Troubleshooting guide or contact [email protected].


Did this page help you?