Ready to Fly
Sample app to showcase Slack + Salesforce integrations.
This app has been created using the Salesforce Slack Starter Kit. For a detailed explanation of the app architecture and the scaffolding script, take a look at Salesforce Slack Starter Kit's README.
Prerequisites
To be able to run this project you will need:
git(download here)node>= 14 (download here)- Salesforce Dev Hub
- If you don't have one, sign up for a Developer Edition org and then follow the instructions to enable Dev Hub.
sfdxCLI >= sfdx-cli/7.129.0 (download here)- Heroku account (signup)
herokuCLI (download here)- Slack Workspace
- If you don't have one, create one.
Setup Steps
Configuring Slack App
- Open https://api.slack.com/apps/new and choose "From an app manifest"
- Choose the workspace you want to install the application to
- Copy the contents of manifest.yml into the text box that says
*Paste your manifest code here*and click Next - Review the configuration and click Create
- In Basic Information scroll down to the Display Information section. Upload a picture for the app. You can use this logo
- Now click Install App on the left menu. Then click the Install to Workspace button and then click on Allow
Running the Scaffolding Script
The scripts/deploy.js script scaffolds all the entities needed for the sample app to work. To run the scaffolding script follow these instructions:
$ sfdx auth:web:login -d -a DevHub # Authenticate using your Dev Hub org credentials (only needed if using JWT bearer flow)
$ heroku login # Login with your Heroku account (or create one)
$ git clone https://github.com/trailheadapps/ready-to-fly
$ cd ready-to-fly/scripts
$ npm install
$ cd ..
$ node scripts/deploy.js
-
During the set up process, the script will prompt you to enter value for
SLACK_BOT_TOKEN. To enter this value open your apps configuration page from this list, click OAuth & Permissions in the left hand menu, then copy the value in Bot User OAuth Token and paste into terminal. -
The script will prompt you for slack signing secret
SLACK_SIGNING_SECRET. To enter this value open your apps configuration page from this list, click Basic Information and scroll to the section App Credentials and click show button and copy the Signing Secret and paste into terminal.
Note: as ready to fly performs calls from Salesforce to Slack, we've modified the Salesforce Slack Starter Kit script to also deploy a remote site setting and a custom metadata type record that are used for callouts. We've also included the setup of some sample data.
Setting Heroku Instance in your Slack App
This is the last step, you will need to enter the current Heroku Instance url in Slack App.
- To enter this value open your apps configuration page from this list, click App Manifest. Find the
request_urlfields (there will be two to update) in the manifest and modify it to replaceheroku-appwith your actual heroku domain name. Note at the end of this step your url should look likehttps://<heroku-domain>.herokuapp.com/slack/events. - Once done that, you'll be prompted to verify the events endpoint. Click on 'verify'. You're ready to navigate to the app home!
How to Build and Deploy Code
-
For Salesforce metadata synchronization use
sfdx force:source:pullto retrieve andsfdx force:source:pushto deploy metadata from orgs to local project folderforce-app -
For the Bolt Node.js app use the steps below:
- cd into apps/ready-to-fly folder
cd apps/ready-to-fly - add git remote to app repo using
heroku git:remote -a <heroku app name> - run
git push heroku mainto push code to Heroku
- cd into apps/ready-to-fly folder
Local Development
- To use ngrok, first install it downloading the executable or with npm:
$ npm install ngrok -g
- Next you’ll have to sign up.
- Once logged in, navigate to “Setup & Installation“ and copy your auth token.
- Then set your auth token in your local machine:
$ ngrok authtoken my_auth_token
- Run the ngrok tunnel as follows:
$ ngrok http 3000
- Copy the ngrok tunnel URL to the following places:
- Your manifest file request URLs
- The HEROKU_URL environment variable in your .env file
- The Callback URL for the connected app that’s used for authorization in Salesforce - simply add the ngrok URL in a new line
- Add a new remote site setting that contains the ngrok URL, as it’s the one that we’ll use to callout from Salesforce to Slack
- Modify the BoltAppConfigHeroku custom metadata type record URL__c, as it’s used in the Apex logic to make the callout
- Now you are prepared to run the app locally! In another terminal different from the one in which you’re running ngrok, execute
node app.jsfrom the project folder. You can then make changes to the code and restart the app as many times as you want.
Note about Managers
The Managers dropdown that appears when you create a travel request is populated with information pulled from Salesforce. Concretelly, we take a look at the standard Nanager field on the User object, and pull two levels of Managers. You can change that behaviour to adapt it to your needs.
65 Oct 3, 2022
1k Jan 7, 2023
1 Dec 19, 2021
38 Sep 9, 2022
15 Dec 13, 2022
13 Dec 12, 2022
45 Dec 9, 2022
6 Aug 23, 2022
13 Dec 31, 2022
2 Jan 25, 2022
9 Aug 23, 2022
49 Jan 2, 2023
17 Jul 31, 2023
14 Dec 17, 2022
3.4k Dec 29, 2022
18 Sep 20, 2022
172 Dec 29, 2022
21 Nov 22, 2022
