Slack

This doc is about how to enable Slack integration in your self hosted instance.

This guide walks you through setting up a Slack app and configuring it for your on-premise Nected deployment so users can connect Slack as an integration from the Nected UI.

Prerequisites

• Access to your on-premise Nected deployment (Helm values and cluster)

• A Slack account (workspace where you can create apps)

• Access to Slack API to create and configure the app

Step 1: Sign Up for a Slack Account

If you don’t already have one, sign up for a Slack account and create or join a workspace where you want to use the Nected Slack integration.

Step 2: Create a Slack App

1. Go to https://api.slack.com.

   
2. Create a new app:

   • Use “Create New App” → “From scratch” (or “From manifest” if you prefer).

   • Choose your App Name and Workspace.

   • Complete the app creation flow.

---

Step 3: Configure OAuth Redirect URL

1. In your Slack app, open the OAuth & Permissions tab.

2. Under Redirect URLs, add your Nected UI redirect URL:

   • Format: https://<your-nected-ui-domain>/auth/redirect

3. Save the changes.

Step 4: Add Bot Scopes

1. Stay in OAuth & Permissions.

2. Scroll to Scopes → Bot Token Scopes.

3. Add the following bot scopes:

   • chat:write

   • chat:write.public

   • channels:read

   • groups:read

   • mpim:read

   • im:read

   • users:read

Step 5: Add User Scopes

1. In the same OAuth & Permissions page, scroll to User Token Scopes.

2. Add the following user scopes:

   • chat:write

   • channels:read

   • groups:read

   • mpim:read

   • im:read

   • users:read

Step 6: Get Client ID and Client Secret

From your Slack app’s Basic Information (or OAuth & Permissions) page, copy:

• Client ID

• Client Secret

You will use these in nected-values.yaml in the next step.

Step 7: Update nected-values.yaml — CREDENTIAL_CONFIG_MAP

1. Open your nected-values.yaml file.

2. Search for the key: CREDENTIAL_CONFIG_MAP.

3. Add the Slack configuration into the existing config object. If the value is a YAML block or JSON string, merge the following Slack entry (and keep any existing entries such as gsheet):

Slack config to add:

{
  "slack": {
    "tokenUrl": "https://slack.com/api/oauth.v2.access",
    "clientId": "<<YOUR-APP-CLIENT-ID>>",
    "clientSecret": "<<YOUR-APP-SECRET>>",
    "authUrl": "https://slack.com/oauth/v2/authorize",
    "grantType": "authorization_code",
    "scopes": "chat:write,chat:write.public,channels:read,groups:read,mpim:read,im:read,users:read",
    "additionalParams": {
      "user_scope": "chat:write,channels:read,groups:read,mpim:read,im:read,users:read"
    }
  }
}

• Replace <<YOUR-APP-CLIENT-ID>> with your Slack app’s Client ID.

• Replace <<YOUR-APP-SECRET>> with your Slack app’s Client Secret.

• If you already have other integrations (e.g. gsheet), keep them in the same object; only add or update the slack key.

Example with Slack and GSheet:

{
  "slack": { ... },
  "gsheet": { ... }
}

Step 8: Update nected-values.yaml — SYNC_PLUGINS

1. In the same nected-values.yaml, search for SYNC_PLUGINS.

2. Add slack to the comma-separated list of plugins. For example:

SYNC_PLUGINS: mysql,mongodb,postgres,sqlserver,redshift,oracle,snowflake,restAPI,gsheet,slack

Adjust the list if your deployment uses a different set of plugins; the important part is that slack is included.

Step 9: Apply Changes with Helm

From your machine (or CI) where Helm and kubectl are configured for your cluster:

helm repo update
helm upgrade -i nected nected/nected -f nected-values.yaml

This applies the updated values (including Slack config and SYNC_PLUGINS) to your on-premise Nected release.

Step 10: Restart Nalanda (If Needed)

If the Helm chart does not redeploy the Nalanda services automatically, trigger a rollout restart:

kubectl rollout restart deploy nected-nalanda

Wait for the rollout to complete, then verify the Nected UI and integrations.

Step 11: If Slack Does Not Appear Under Integrations

If Slack does not show up under the Integrations tab in the Nected app, sync plugins from inside the Nalanda pod:

1. Get the Nalanda pod name:

   kubectl get pods -l app=nected-nalanda

2. Run the plugin sync inside the pod:

   kubectl exec -it <<nalanda-pod-name>> -- /bin/bash
   ./nalanda sync plugin
   exit

Replace <<nalanda-pod-name>> with the actual pod name (e.g. nected-nalanda-7d8f9c-xyz12).

After the sync completes, refresh the Nected UI and check Integrations again; Slack should be available to connect.

Summary Checklist

1. Sign up for Slack.

2. Create app at api.slack.com.

3. Set redirect URL: https://<nected-ui-domain>/auth/redirect.

4. Add bot scopes: chat:write, chat:write.public, channels:read, groups:read, mpim:read, im:read, users:read.

5. Add user scopes: chat:write, channels:read, groups:read, mpim:read, im:read, users:read.

6. Copy Client ID and Client Secret.

7. Add Slack config to CREDENTIAL_CONFIG_MAP in nected-values.yaml.

8. Add slack to SYNC_PLUGINS in nected-values.yaml.

9. Run helm repo update and helm upgrade -i nected nected/nected -f nected-values.yaml.

10. If needed: kubectl rollout restart deploy nected-nalanda.

11. If Slack missing in UI: kubectl exec -it <nalanda-pod> -- /bin/bash then ./nalanda sync plugin.

Troubleshooting

• Slack not in Integrations list: Ensure slack is in SYNC_PLUGINS and run ./nalanda sync plugin inside the Nalanda pod (Step 11).

• OAuth errors: Confirm the redirect URL in Slack exactly matches your Nected UI domain and path (/auth/redirect), and that Client ID and Client Secret in CREDENTIAL_CONFIG_MAP are correct.

• Missing scopes: Reinstall the app to your workspace after adding bot and user scopes so new permissions are granted.