Skip to content
Prism
CLI
For a shorter method of install the plugin, see the two commands below. Open a Terminal in your Prism Plugin directory and copy/paste/type in these commands:
git clone Slack
pip install -r requirements.txt -t ./PythonLibs
Plugin
If you want to avoid the next 4 steps below, you can open a terminal in the Prism Plugins directory and run this command
git clone Slack
1. Download the Plugin
Option 1: Download the current release package from the repository's release page.
Option 2: Download the repository as a ZIP file using the Code dropdown menu on the main repository page.
2. Unzip the File (if needed)
If you downloaded a ZIP file, extract its contents to a folder.
3. The Top level folder must be called: Slack, so if you need to please rename it.
4. Move the Plugin to the Prism Plugin Folder
Locate your Prism Plugin folder. Drag and drop the downloaded or unzipped plugin folder into the Prism Plugin folder.
5. Reload Prism
Restart or reload Prism.
The Slack plugin should automatically appear in the plugin list and be checked as enabled.
Slack API’s
We did not include the Slack API’s in the repository to limit the size of it. You can either download the release package or you can download it on your own. If you chose to download it on your own, please follow the steps below to do so.
If you want to avoid all of these steps below, you can open a terminal in the Slack plugin directory and run this command
pip install -r requirements.txt -t ./PythonLibs
1. Install the Slack Bolt and Slack SDK
pip install slack_sdk
pip install slack_bolt
2. Locate Slack API packages
If you do not know where to find the packages you just installed, run this command
pip show slack_sdk
pip show slack_bolt
3. Copy/move them to this folder
If the PythonLibs folder does not exist, create it
{PRISM_PLUGIN_DIRECTORY}/Slack/PythonLibs
Slack
Slack Prism App
1. Use the Provided Manifest
Locate the file in the Resources folder of the repository. This file simplifies the bot creation process.
{PRISM_PLUGIN_DIRECTORY}/Slack/Resources/manifest.yml
2. Create Your Slack App
Go to the page on the Slack API website. Follow the instructions for creating apps using manifests provided on this page: .
Use the file during the app creation process. You can copy/paste it into the YAML section on the second prompt.
3. Customize the App Icon (Optional)
Once your app is created, navigate to the Basic Information page in the Slack API dashboard.
Under the Display Information section, upload an App Icon to personalize your app.
4. Install the App
In the left-hand menu, select the Install App section.
Install the app into your Slack workspace.
5. Obtain the Bot User OAuth Token
Go to the OAuth & Permissions page in the left-hand menu.
Copy the Bot User OAuth Token displayed on this page. It should start like this: xoxb-
6. Enter the Token in Prism Settings
Open the Slack Project/Studio Settings page in Prism. Paste the copied Bot User OAuth token into the appropriate field.
7. Obtain the Bot App-Level Token (Optional if you want to enable server functionality)
Select the Write token to open a window that contains a token that starts with: xapp-
If you do not see a token, then generate the Write Token
8. Enter App-Level Token in Prism Settings (Optional if you want to enable server functionality)
Open the Slack Project/Studio Settings page in Prism. Paste the copied App-Level Token into the appropriate field to complete the integration.
Recommendations
Mixing Workstations/Render Nodes with no Prism+ license
If you have render nodes or workstations that don’t have a license for Prism+, but a number of your other machines do, then I would highly recommend you set this environment variable:
PRISM_STUDIO_PATH
The Slack plugin will make use of this environment variable if Studio is not enabled. For us this points directly to the studio config path. The Slack config is stored in the same location as the studio config to make things easy for you.
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.