jensenhwa / piazza-link-bot

Slackbot that automatically links to Piazza posts.

piazza-link-bot: slackbot to auto-link to Piazza posts

Simple slackbot for responding to messages containing a Piazza post number.

Based on regexbot by sjmelia.

Got an out-of-date deployment?

Go to HOW-TO-UPDATE.md for instructions on how to update your deployment to the latest version.

Full instructions

Create Slack App

1. Go to https://api.slack.com/apps, create a new App, and connect it to the workspace of your choice.
2. Add a bot user to your app.
3. Install your app to your workspace in its current state (in order to generate access tokens).
4. Go to "OAuth and Permissions" to find your Bot User OAuth access token. This will be the SLACK_API_TOKEN used by the Heroku app.
5. Go to "Basic Information" to find your Signing Secret. This will be the SIGNING_SECRET used by the Heroku app.

Set up Heroku App

1. Click the "Deploy to Heroku" button and choose a name for your Heroku app.
2. Fill in all of the required environment variables (e.g. slack api token, piazza base url).
3. Deploy the app.

Link Slack Events to the Heroku App

1. Go to Event Subscriptions, enable events, and connect it to your Heroku app's url. The path for events is /slack/events.
2. Add the following Bot event subscriptions:

• message.channels
• message.groups
• message.im
• message.mpim

1. Reinstall the Slack app. The access tokens should remain the same.

Finally, in your Slack workspace, invite the bot user to any channels you wish it to have access to.

Real-Time Messaging API vs. Events API

By default, this bot uses the Slack Events API to listen to messages. This allows the bot to work on free-tier Heroku dynos, for example, because it uses HTTP requests rather than websockets. If you have a persistent server and would like to use the Slack Real-Time Messaging API instead, set the USE_RTM environment variable (to anything).

Development

npm test to lint and run tests