Skip to Content

Slack prerequisites

Introduction

These are the prerequisites for using the Slack connector. You first create a Slack app in the selected workspace, and then add scopes to the created app.

These steps include these instructions:

Create a Slack app

Follow these steps to create a Slack app in the selected workspace:

  1. On the Slack API website, click Create an App and then click From scratch.

  2. Provide a name for your app and select a workspace, then click Create App:

    Slack application creation

  3. Go to the Incoming Webhooks page (accessed from the Features menu) and toggle the Activate Incoming Webhooks option to On, then click Add New Webhook to Workspace:

    Slack application creation

  4. From the menu, select the Slack channel where you want to post messages and click Allow:

    Slack application creation

    Note

    Approval may be required from someone who manages apps in your workspace. Use the Request to Add New Webhook button to send a request for approval.

Add scopes

Follow these steps to add scopes to the created app:

  1. On the OAuth & Permissions page (accessed from the Features menu), go to the Scopes section and click Add an OAuth Scope under the Bot Token Scopes or User Token Scopes section (depending on the type of token you are using):

    Slack scopes

  2. Add these scopes depending on the activities to be used:

    Activity Scope
    Search chat:write
    chat:write.customize
    chat:write.public
    conversations.connect:manage
    conversations.connect:read
    conversations.connect:write
    Post calls:read
    calls:write
    chat:write
    chat:write.customize
    chat:write.public
    conversations.connect:manage
    conversations.connect:read
    conversations.connect:write
    dnd:read
    files:read
    files:write
    remote_files:read
    remote_files:share
    remote_files:write
    pins:read
    pins:write
    reactions:read
    reactions:write
    reminders:read
    reminders:write
    usergroups:read
    usergroups:write
    users.profile:read
    users:read
    users:read.email
    users:write
    Chat conversations.connect:manage
    conversations.connect:read
    Get calls:read
    calls:write
    chat:write
    chat:write.customize
    chat:write.public
    conversations.connect:manage
    conversations.connect:read
    conversations.connect:write
    dnd:read
    files:read
    files:write
    remote_files:read
    remote_files:share
    remote_files:write
    pins:read
    pins:write
    reactions:read
    reactions:write
    reminders:read
    reminders:write
    usergroups:read
    usergroups:write
    users.profile:read
    users:read
    users:read.email
    users:write
    team.billing:read
    team.preferences:read
    team:read
    workflow.steps:execute
    Files files:read
    files:write
    remote_files:read
    remote_files:share
    remote_files:write
    Conversations conversations.connect:manage
    conversations.connect:read
    conversations.connect:write
    Users users.profile:read
    users:read
    users:read.email
    users:write

Obtain an OAuth token

If you are authenticating the connection with a bot token or user token, follow these steps:

  1. Go to the OAuth & Permissions page accessed from the Slack API website's Features section.

  2. To obtain a bot token, copy the Bot User OAuth Token (prefixed with xoxb) under OAuth Tokens.

    To obtain a user token, copy the User OAuth Token (prefixed with xoxp) under OAuth Tokens:

    Slack application creation

    Note

    The User OAuth Token is visible only when User Token Scopes have been added to the app.

Configure 3-legged OAuth

This section covers the steps for authenticating the connection to use 3-legged OAuth 2.0 (3LO) authentication with a private application configured in the Management Console App Registrations page.

Private applications are applications that you configure for the Slack instance (described in Create a Slack App) and then register in the Management Console App Registrations page with these values from the Slack app:

  • Client ID and client secret
  • Scopes
  • Authorization URL
  • Access token URL
  • Refresh token URL

Note

When using the cloud application (Jitterbit App), an app registration is not used.

Redirect URL

When configuring your application in Slack, ensure the Redirect URL is set to one of the following URLs (depending on your organization's region):

Region URL
APAC https://apps.apac-southeast.jitterbit.com/design-studio/api/v1/oauth/authcode
EMEA https://apps.emea-west.jitterbit.com/design-studio/api/v1/oauth/authcode
NA https://apps.na-east.jitterbit.com/design-studio/api/v1/oauth/authcode

Instructions

These are the instructions for obtaining the required values for the app registration:

  1. Configure an OAuth application for the Slack instance.

  2. Navigate to your application on the Slack API website.

  3. To obtain the client ID and client secret for the app registration, go to your Slack app's Basic Information page. The values are located under the App Credentials section:

    client id and secret

  4. To obtain the Scopes for the app registration, go to your Slack app's OAuth & Permissions page, navigate to the Scopes section and obtain the scopes used for the app. In the app registration's configuration, enter each of the app's scopes in its code format, for example, read:me.

  5. Set the app's Authentication URL as https://slack.com/oauth/v2/authorize.

  6. Set the app's Access token URL as https://slack.com/api/oauth.v2.access.

  7. Set the app's Refresh token URL as https://slack.com/api/oauth.v2.access.

  8. Go to Advanced options.

    In the Token request tab under Parameters, enter Accept-Encoding as the Key and */* as the Value. Then select Request Header from the Send in menu.

    Note

    The Access token URL is prepopulated with the value provided in step 6 and should not be changed.

  9. In the Refresh request tab under Parameters, enter these key-value pairs:

    • For the first key-value pair, enter Accept-Encoding as the Key and enter */* as the Value. Then select Request Header from the Send in menu.

    • For the second key-value pair, enter grant_type as the Key and enter refresh_token as the Value. Then select Request URL from the Send in menu.

      Note

      The Refresh token URL is prepopulated with the value provided in step 7 and should not be changed.

Once the 3-legged OAuth application is registered on the App Registrations page it is available to be selected in the OAuth Application menu under Private Applications in the Slack connection.