Slack DevKit

Slack DevKit is a light-weight developer kit to build Slack Apps in node.js super fast. No previous knowledge about building Slack Apps or Bots needed! Plus, automatic support for verifying requests from Slack and responding to validations.

This was made to build Slack Apps on Glitch even faster, but it works everywhere!

Learn more on SlackDevKit.com

Overview

Features

OAuth support without 3rd-party database
Supports Single Channel Installations
Verifies request signatures and/or verification tokens
Support for short-lived tokens with automatic refresh
Automatic retrieval of workspace's authentication info
Auto-parsing of string-encoded JSON payloads
Authenticated HTTP client for Slack's API
Writeable datastore associated to the workspace

What's Included

App - The Slack App
Request - The request made from Slack
Client - Minimal HTTPS client (to call other APIs)
Payload - Wrapper for Slack payloads (to standardize attributes)
Router - An Express.js router (middleware)
Express - An Express.js instance with the router attached
Lambda - An AWS Lambda AWS Lambda handler
FileStore - File-based storage to save workspace information
DynamoDB - DynamoDB storage to save workspace information

Examples

File	Description
features.js	Examples of some common Slack App features
internal-integration.js	Example configuration of an internal integrations
storing-data.js	Example of storing and retrieving data from the datastore
express.js	Example of adding Slack DevKit to an exiting Express.js server
lambda.js	Using Slack DevKit with AWS Lambda and DynamoDB

Getting Started

Install

npm i slack-devkit

Usage

const Slack = require('slack-devkit');

// Configure express with the Slack App settings
const { server } = new Slack({
  scope: 'chat:write,bot',
  client_id: '1212313.1231231231231',
  client_secret: '12312312323123123',
  signing_secret: 'sdfsadfsadfasdfas',
  redirect_uri: 'https://myserver.com', // optional
  datastore: '.data/workspaces' // optional
});

// All GET routes redirect to the “Add to Slack” OAuth flow
server.get('/', (req, res) => {
  req.slack.data; // the authenticated workspace info
  res.send();
});

// All POST routes expect Slack callback events
// and verify against the verification token
server.post('/', (req, res) => {
  const user = req.slack.user_id;
  req.slack.api('users.info', { user }).then(r => {
    r.data; // the results of 'users.info' API request
  });
  res.send();
});

// Start the webserver on port 3000
server.start(3000);

Configuration

The configuration options used for the constructor

Name	Type	Description
`scope`	Required	Slack OAuth scopes
`client_id`	Required	Slack OAuth client id
`client_secret`	Required	Slack OAuth client secret
`redirect_uri`	Optional	Slack OAuth redirect uri
`signing_secret`	Optional	Slack signing secret
`verification_token`	Optional	Slack verification token
`access_token`	Optional	Access token for internal integrations
`slack_root`	Optional	Root domain to use for Slack requests
`datastore`	Optional	File path to write to or a DataStore object

johnagan/slack-devkit