Slack

Read channels and users, and post messages as the signed-in Slack user.

Communication
OAuth 2.0 + PKCE
Works on Free plan
Bundled in Kirak
Maintained by Kirak

How to use it

This profile ships with Kirak. Add "integrations" to modules in kirak.json, then name the profile as below. There is nothing to download, and a copy in your project's integrations/ folder is an error.

Environment variables

Variable	Holds
`KIRAK_INTEGRATION_SLACK_CLIENT_SECRET`	The OAuth client secret from the vendor's console. Secret: keep it out of kirak.json and out of source control.
`KIRAK_AUTH_ENCRYPTION_KEYS`	Encrypts stored tokens. Shared by every integration; the module refuses to start without it.

The names follow the integration's name in kirak.json (slack here). Name it something else, such as slack_sales, and the variables change to match.

Redirect URL

Register this as the redirect (callback) URL in the vendor's console, with your app's address in place of <your-app> (the base_url in kirak.json):

https://<your-app>/integrations/slack/callback

How to get your keys

Open Slack’s app page and choose Create New App > From scratch.
Under OAuth & Permissions, add https://<your-app>/integrations/slack/callback as a redirect URL.
Under User Token Scopes (not bot scopes), add the scopes your app needs. At least: users:read (Read user profiles in the workspace), channels:read (View basic information about channels)
Under Basic Information > App Credentials, copy the client ID and the client secret.
Put the client ID in kirak.json as integrations.providers.slack.client_id, and the client secret in the environment as KIRAK_INTEGRATION_SLACK_CLIENT_SECRET. Never put the secret in kirak.json.

The vendor's own guide · Instructions out of date? ·Suggest an edit

kirak.json

Scopes users:read Read user profiles in the workspace channels:read View basic information about channels chat:write Post messages as the user search:read Search the workspace as the user

{
  "integrations": {
    "providers": {
      "slack": {
        "type": "oauth2",
        "profile": "slack",
        "client_id": "your-client-id",
        "scope": [
          "users:read",
          "channels:read"
        ]
      }
    }
  }
}

Merged into the profile: scope replaces the profile's default scopes.

Good to know

User tokens are read from authed_user, because the scopes go in user_scope. Bot scopes would use scope and a bot token.
Slack tokens do not expire unless token rotation is turned on for the app; with rotation, the app must refresh them.
The workspace is the account: one connection per workspace (team.id).
Scope separator and the redirect URL rules (https even for local development) are to be confirmed in Slack's app settings before a release.

Example calls

GET /conversations.list: List the channels the user can see

Help improve this profile

Report a problem ·Suggest an edit to profile.json ·Add a profile ·Vendor docs the profile was checked against

Product names and logos are trademarks of their respective owners. Their use does not imply endorsement. To ask for this icon to be removed, email trademark@kirak.io.