/uptae

A Slack Bot for to help your team know what everyone is up to. Which isn't finished. Yet.

Primary LanguageJavaScript

Uptae

Twitter: @weejames

Deploy

Uptae is a Slackbot that you and your team can use to let each other know what you're upto.

Stuck in meetings all day? Out of the Office? On holiday? Tell Uptae and it'll let everyone know.

Installation

Uptae is designed to be installed directly on to Heroku as a Heroku app. It requires a web server and a Postegres DB server.

Note: If you're running Uptae on the Heroku free tier then the web server will go to sleep after 30 minutes of inactivity. If you're using Uptae regularly throughout the day then you'll be fine, but if no one interacts with it for 30 minutes then the first command will likely see a Timeout error while it starts up.

Requirements

You'll need need a Slack team and the ability to set up custom integrations.

As part of installation you'll set up:

  1. Slash Command to allow you to interact with Uptae
  2. Incoming Web Hook to let Uptae post daily summaries

Configuring the Slash Command

While signed in to your Slack team make a Custom Integration, and select the 'Slash Commands' option.

  1. Give your command a name (like /uptae) and select 'Add Slash Command Integration'.
  2. In the URL field enter the enter the URL of your Heroku Application with the /commands endpoint (you might need to come back to this after deployment if using the Heroku Button with a randomly generated name).
  3. A Token will have been generated. This will be the SLACK_TOKEN value you need during deployment.
  4. Set the 'Customize Name' value to 'Uptae'.

Configuring the Incoming Web Hook

Again, while signed in to your Slack team again make a Custom Integration, but this time select 'Incoming Web Hooks'.

  1. Choose the channel you'd like Uptae to post it's daily summary to and select 'Add Incoming Web Hooks integration'.
  2. Make a note of the 'Webhook URL'. This will be the WEBHOOK_URL you need during deployment.
  3. Enter the username you entered previously into the 'Customize Name' field and select 'Save Settings'.

Environment Variables

  • WEBHOOK_URL The Webhook URL from configuring the Incoming Web Hook
  • SLACK_TOKEN

Configure Notifications

Uptae will send a message to your configured channel

Using Uptae

Adding an entry

Note: If you already have an entry for a date, and you specify another entry for that date, the original will be overwritten. No history, or backup of the original entry is maintained.

Seeing your existing entries

Coming soon

Deleting an entry

Coming soon

Creating an entry for someone else

Coming soon

When you create an entry for someone else they will be notified directly by Uptae.

Daily Notifications

If you've configured the Notifications from Uptae, then each day it will post a message to your chosen channel detailing all of the entries for today and for tomorrow.

Getting Help

Once Uptae is in one of your channels you can get a reminder of all of the supported operations using /uptae help.