Configuring a custom Slack application

This guide provides step-by-step instructions on creating and configuring a custom Slack application. It is intended for IT/HR administrators who want to integrate the application with their organization’s workspace.

Prerequisites

Before starting the installation process, ensure that you have the following:

• Slack Workspace: A Slack workspace where you intend to install the application.
• Admin Access: Administrator rights are available for your Slack workspace.
• Account Access: Applications connect to the account, so make sure you have the necessary URL and user account credentials.
• AI assistant setup: The AI assistant bot should be enabled on the application to connect to Slack by enabling the checkbox ‘Use this bot to interact with external bots and generate responses.’

Step 1: Create a Slack Application

1. Go to Slack API:
   • Visit the Slack API website and log in using your Slack credentials.
2. Create a New Application:
   1. Click on "Create New App".
   2. Choose a method:
      • From Scratch: Build your app from the ground up.
      • Manifest File: Upload a manifest file if you have pre-configured settings.
   3. Choose ‘From Scratch’
   4. Enter your application name.
   5. Choose the Slack workspace where the app will be installed.
   6. Click Create App.

Step 2: Provide App Credentials to Applaud

• Go to Display information:
  
  • Go to Basic Information on the new application and navigate to App Credentials.
• Provide the following details:
  
  • Client ID
  • Client Secret: After, select Show.
  • Signing Secret: After, select Show.

Step 3: Configure branding

1. Go to Display information:
   • Go to Basic Information on the new application and navigate to Display Information. 
2. Choose branding details:
   • App name: Name of your bot application.
   • Short description: Describe your bot in one line sentence.
   • App icon: Add an image representing your bot on the conversation body.
   • Background color: Background color of your bot icon while on the conversation body.
   • Long description: A description of your bot will be shown on your App Detail page.
3. Click Save Changes.

Step 4: Configure Interactivity & Shortcuts

• Enable Interactivity:
  1. Navigate to Interactivity & Shortcuts in the sidebar.
  2. Toggle the Interactivity switch to On.
• Request URL:
  1. Enter the URL that Slack should use to send interactive payloads. E.g. https://company-com.applaudcloud.com/slack/events. The applaud team generates the Request URL to add it here.
  2. Click Save Changes

Step 5: Configure OAuth & Permissions

1. Navigate to OAuth & Permissions:
2. In the app's dashboard, click on OAuth & Permissions from the sidebar.
3. Choose Scopes and Bot Token scopes:
   
   • Add the necessary scopes under OAuth Scopes to which your application needs access. Common scopes include:
     • channels:history
     • channels:read
     • chat:write
     • im:history
     • users:read
     • users:read:email
4. Redirect URL:
   1. Add the redirect URL for OAuth purposes, E.g., https://company-com.applaudcloud.com/oauth/callback. The applaud team generates the Redirect URL to add it here.
   2. Click Save Urls

Step 6: Configure Event Subscriptions

• Event Subscriptions:
  
  • Navigate to Event Subscriptions in the sidebar.
  • Toggle the Enable Events switch to "On."
• Request URL:
  
  • Enter the URL that Slack should use to notify users when an event occurs, E.g., https://company-com.applaudcloud.com/slack/events. The Applaud team generates the Request URL and adds it here.
  • Click Save Changes.

Step 7: Install the Application

1. Install the App:
   • Go to Install app and install the app in the workspace.
2. Authorize the App:
   1. As part of the installation, review the permissions the app is requesting.
   2. Click Authorize to grant the app the necessary permissions within your workspace.
   3. Click on Open Slack to return to your workspace.
3. Verify Installation:
   • Ensure the app has been installed correctly by checking the Apps section in the Slack application sidebar.

Step 8: Connect the instance to the application

1. Go to App Home:
   • In the Slack sidebar, navigate to "Apps," find the custom app installed, click on the Home tab, and select Connect to Application.
2. Connect:
   • Enter your application URL (E.g., https://company-com.applaudcloud.com) and click Submit.

Step 9: Connect the user account

1. Go to App Home:
   • In the Slack sidebar, navigate to "Apps," find the custom app installed, click on the Home tab, and select Connect your account.
2. Authorize with user account credentials
   • The application redirects to the application URL to enter the user credentials to log in to the account.

Step 10: Test the Application

• Test Key Features:
  • Ensure that the application responds promptly without errors to confirm that the setup is completed and connected to the user account.

Step 11: Provide Access to Team Members

1. Notify the Team:
   • Inform relevant team members that the app has been installed. Share usage instructions
2. Team member user account authorization:
   • Custom Slack application is already connected to the application URL, each team member connects to the respective user account with the credentials.

Additional instructions (If Needed)

Disconnect user account

• Go to App Home:
  • In the Slack sidebar, navigate to "Apps," find the Custom app, click the Home tab, and select Disconnect your account. Disconnect only the respective user but not all user accounts.

Connect to a different Application

• Go to App Home:
  • In the Slack sidebar, navigate to "Apps", find the Custom app, click on the Home tab and select Disconnect Application.

Distribution of Application

• Go to Manage distribution:
  • In the app's dashboard, click on Manage distribution from the sidebar and navigate to Share Your App with Other Workspaces.
• Remove hard-coded information:
  • Click on Remove Hard coded Information and select the checkbox ‘I’ve reviewed and removed any hard-coded information.’
  • Click Activate Public Distribution to generate a public installation link for the application
• Share the link:

Copy the Sharable URL provided. This link can be shared with any other Slack workspace, allowing them to install the application.

Uninstallation

1. Go to App Management:
   • In the Slack sidebar, navigate to "Apps," find the Custom app, click the About tab, and select Configuration.
2. Remove App:
   1. Go to the app’s settings or details page and look for the "Remove App" option.
   2. Confirm the removal, and Slack will uninstall the app from your workspace.
3. Notify the Team:
   • If your team used the app, let them know about the uninstallation.

If you’re on the Enterprise Grid subscription, you can install the Custom Slack application at the org level and add it to any workspaces that need access.