Skip to content

Latest commit

 

History

History
 
 

oauth

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

Bolt for JavaScript OAuth Test App

This is a quick example app to test OAuth with Bolt for JavaScript.

If using OAuth, Slack requires a public URL where it can send requests. In this guide, we'll be using ngrok. Checkout this guide for setting it up. OAuth installation is only needed for public distribution. For internal apps, we recommend installing via your app configuration.

Before we get started, make sure you have a development workspace where you have permissions to install apps. If you don’t have one setup, go ahead and create one. You also need to create a new app if you haven’t already. You will need to enable Socket Mode and generate an App Level Token.

Install Dependencies

npm install

Setup Environment Variables

This app requires you setup a few environment variables. You can find these values in your app configuration.

export SLACK_CLIENT_ID=YOUR_SLACK_CLIENT_ID
export SLACK_CLIENT_SECRET=YOUR_SLACK_CLIENT_SECRET
export SLACK_SIGNING_SECRET=YOUR_SLACK_SIGNING_SECRET

Run the App

Start the app with the following command:

npm start

Running with OAuth

Only implement OAuth if you plan to distribute your application across multiple workspaces. Uncomment out the OAuth specific comments in the code. If you are on dev instance, you will have to uncomment out those options as well.

Start ngrok so we can access the app on an external network and create a redirect URL for OAuth.

ngrok http 3000

This output should include a forwarding address for http and https (we'll use the https one). It should look something like the following:

Forwarding   https://3cb89939.ngrok.io -> http://localhost:3000

Then navigate to OAuth & Permissions in your app configuration and click Add a Redirect URL. The redirect URL should be set to your ngrok forwarding address with the slack/oauth_redirect path appended. ex:

https://3cb89939.ngrok.io/slack/oauth_redirect

Start the OAuth flow from https://{your own subdomain}.ngrok.io/slack/install