Salesforce to Webex Contact Sync

This is a Node.js app that uses Salesforce and Webex Oauth to sync contacts from Salesforce to Webex. It is intended to be used as a reference for developers who want to build a similar integration.

Overview

This project creates a locally running Node.js web server which lets you authenticate using a Webex Integration OAuth redirect URL flow. It then sets up a cron job to continually refresh the access token. In example, the project refreshes the token ever 24 hours.

Project then uses the access token to sync contacts from Salesforce to Webex.

Setup

Prerequisites & Dependencies:

• Node 16+
• Webex User Account
• Webex OAuth Integration - Guide provided below
  • Additional information available here: https://developer.webex.com/docs/integrations
• Salesforce User Account
• Salesforce OAuth Integration - Guide provided below
  • Additional information available here: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_authentication.htm

Installation Steps:

1. Clone this repository and change directory:

   git clone https://github.com/sieteunoseis/salesforce-webex-contact-sync.git && cd salesforce-webex-contact-sync
   

2. Rename the example environment file from .env.example to .env:

   cp env.example .env
   

3. Configure the environment file for the Salesforce/Webex OAuth Integration.
   Additional guide on where to get these values is below

   SALESFORCE_CLIENT_ID=<CLIENT_ID>
   SALESFORCE_CLIENT_SECRET=<CLIENT_SECRET>
   SALESFORCE_USERNAME=<USERNAME>
   SALESFORCE_PASSWORD=<PASSWORD>
   SALESFORCE_SECURITYTOKEN=<SECURITY_TOKEN>
   WEBEX_ORG_ID=<ORG_ID>
   WEBEX_APP_CLIENT_ID=<CLIENT_ID>
   WEBEX_APP_CLIENT_SECRET=<CLIENT_SECRET>
   WEBEX_APP_RETURN_URL=http://localhost:3000
   WEBEX_APP_REDIRECT_URL=http://localhost:3000/oauth
   WEBEX_APP_AUTHORIZATION_URL=https://webexapis.com/v1/authorize
   WEBEX_APP_TOKEN_URL=https://webexapis.com/v1/access_token
   WEBEX_APP_SCOPES=Identity:contact
   PORT=3000

4. Install project:

   npm install
   

5. Start the server in development mode (using a local env file):

   npm run dev
   

   or start the server in production mode:

   npm run start
   

6. Navigate using your browser to the link below to begin the OAuth flow which will give this project a refresh and access token based off your Webex Account:

   http://localhost:3000
   

Docker Setup:

Build and run using Docker:

npm run docker:build
npm run docker:run

Note: Update the config section of the package.json file to change the name and platform.

OR

Pull image from Docker.io and run with the following::

docker run -d -p 3000:3000 --name salesforce-webex-sync --restart=always --env-file=.env -v ./data:/app/data sieteunoseis/salesforce-webex-contact-sync:latest

Setup Webex OAuth Integration:

1. Navigate to this page to create a new Webex Integration using your Webex Account:
   https://developer.webex.com/my-apps

2. Click on Create a New App

3. Click on Integration

4. Fill out your intergration details, enter any name and decription and select any icon:

   • For Redirect URI(s), enter: http://localhost:3000/oauth
     (or the url where you intend to deploy this code. The app expects the url to end in /oauth)
   • For scopes, select only Identity:contact
     (or the scopes you intend to use for your integration)

5. Scroll to the bottom and click Add Integration.

6. Take a note of the Client ID and Client Secret for the environment file configuration above

Setup Salesforce OAuth Integration:

1. Navigate to this page to create a new Salesforce Integration using your Salesforce Account:
   https://login.salesforce.com/
2. Click on Setup
3. Click on Apps
4. Click on App Manager
5. Click on New Connected App
6. Fill out your intergration details, enter any name and decription and select any icon:
   • For Callback URL, enter: http://localhost:3000/oauth
     (or the url where you intend to deploy this code. The app expects the url to end in /oauth)
   • For Selected OAuth Scopes, select only Manage user data via APIs (api)
     (or the scopes you intend to use for your integration)
7. Click on Save
8. Once saved click on Manage Consumer Details
9. Take a note of the Consumer Key and Consumer Secret for the environment file configuration above
10. Click on Manage at the top and then Edit Policies
11. Under OAuth Policies select All users may self-authorized
12. Under IP Relaxation, select Relax IP restrictions
13. Click on Save
14. Next select Settings > Identity > OAuth and OpenID Connect Settings.
15. Under OAuth and OpenID Connect Settings select Allow OAuth Username-Password Flows

Screenshots

License

All contents are licensed under the MIT license. Please see license for details.

Giving Back

If you would like to support my work and the time I put in creating the code, you can click the image below to get me a coffee. I would really appreciate it (but is not required).