Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.33 KB

README.md

File metadata and controls

34 lines (23 loc) · 1.33 KB
Raw

Sponsored by Beep Boop

botkit-storage-beepboop

Storage module for Botkit when running on Beep Boop. Internally this module uses the BeepBoop Persist API along with the Slack Teams API to provide a Botkit storage adapater.

Install

npm install --save botkit-storage-beepboop

Usage

This module expects the following environment variable to be set for authentication. It's set automatically when running on Beep Boop, but when running locally you need to make sure you set it appropriately.

BEEPBOOP_TOKEN="API_TOKEN_FROM_BEEPBOOP_PROJECT"
var BotkitStorageBeepBoop = require('botkit-storage-beepboop')

var controller = Botkit.slackbot({
  storage: BotkitStorageBeepBoop()
})

BotkitStorageBeepBoop([options])

Returns a Beep Boop Perist api:

  • options.token - defaults to process.env.BEEPBOOP_TOKEN - auth token passed into environment by Beep Boop
  • options.url - defaults to process.env.BEEPBOOP_API_URL || 'https://beepboophq.com/api/v1 - api url passed into environment by Beep Boop