Skip to content

stripethree/slack-events-relay

Repository files navigation

Slack Events Relay

While working on launch-vehicle-fbm, my team started writing a client to dump chat interactions to a private Slack channel for debugging purposes. This evolved into messenger-slack-ghost. What I am looking to do here is evolve this concept into something I can use to debug events on websites I manage by providing some details to a Slack channel.

Node.js CI Maintainability Test Coverage

Prerequisites

Access to a Slack team with the permissions to create an application and bot user are required. Slack will provide a SLACK_BOT_TOKEN and this token needs to be available in the runtime environment.

Use example.env as a guide.

My workflow is to copy this file to .env and use export $(cat .env | xargs) to prepare the environment.

Usage

  • yarn to install dependencies
  • yarn run dev to start a local instance of the application with a file watcher

With the dev target running, http://localhost:8080 will provide an HTTP 200 response with a 🤖 in the body.

Logging and metrics

The debug package is for a firehose of data sent to stdout/stderr

Additional information

Environment variables

Key Required? Default?
API_KEY Y none
PORT N 8080
SENTRY_DSN N none
SLACK_BOT_TOKEN Y none
SLACK_CHANNEL_ID Y none

Endpoints

Route Methods Description
/ GET root route