puneetchd / CapsuleCRM-slack-integration

Slack <> Capsule CRM Integration

This is a Slack App which integrates with Capsule CRM for productivity and Sales function enhancement. Capsule CRM is a software which helps streamline your organization-wide sales, marketing, customer support, and inventory management functions in a single system.

With Capsule CRM and Slack integration, you can share information from CRM with your team members in Slack so you work with better context.

Features

1. List Assigned Opportunities.
2. Update Opportunity Details.
3. Inform channel CRM updates using Webhooks, conditional logics to streamline workflow.

Solution Design

The solution uses Bolt.js framework connecting with Capsule CRM API's for CRUD operations.

Before getting 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.

Installation

Create a Slack App

1. Open https://api.slack.com/apps/new and choose "From an app manifest"
2. Choose the workspace you want to install the application to
3. Copy the contents of manifest.json into the text box that says *Paste your manifest code here* (within the JSON tab) and click Next
4. Review the configuration and click Create
5. Click Install to Workspace and Allow on the screen that follows. You'll then be redirected to the App Configuration dashboard.

Environment Variables

Before you can run the app, you'll need to store some environment variables.

1. Rename .env.sample to .env
2. Open your apps configuration page from this list, click OAuth & Permissions in the left hand menu, then copy the Bot User OAuth Token into your .env file under SLACK_BOT_TOKEN
3. Click Basic Information from the left hand menu and follow the steps in the App-Level Tokens section to create an app-level token with the connections:write scope. Copy that token into your .env as SLACK_APP_TOKEN.

Setup Your Local Project

# Clone this project onto your machine
git clone https://github.com/slack-samples/bolt-js-starter-template.git

# Change into this project directory
cd bolt-js-starter-template

# Install dependencies
npm install

# Run Bolt server
npm start

Linting

# Run eslint for code formatting and linting
npm run lint

Project Structure

manifest.json

manifest.json is a configuration for Slack apps. With a manifest, you can create an app with a pre-defined configuration, or adjust the configuration of an existing app.

app.js

app.js is the entry point for the application and is the file you'll run to start the server. This project aims to keep this file as thin as possible, primarily using it as a way to route inbound requests.

/slack/listeners

Every incoming request is routed to a "listener". Inside this directory, we group each listener based on the Slack Platform feature used, so /listeners/shortcuts handles incoming Shortcuts requests, /listeners/views handles View submissions and so on.

/services

capsule-client.js contains the business logic to interact with Capsule CRM API's for CRUD operations.

This Slack App also integrates with incoming webhooks to inform channel about changes done to opportunities, stage changes etc. To achive this a simple cloud functions is triggered locally or via Google Cloud functions.