https://github.com/comcast/akamai-slack-reporter

A Slack slash command integration for querying your team's Akamai configuration
https://github.com/comcast/akamai-slack-reporter

Last synced: 4 months ago
JSON representation

A Slack slash command integration for querying your team's Akamai configuration

• Host: GitHub
• URL: https://github.com/comcast/akamai-slack-reporter
• Owner: Comcast
• License: other
• Created: 2016-02-23T20:47:41.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-08-06T23:24:57.000Z (almost 8 years ago)
• Last Synced: 2025-07-21T01:39:02.389Z (11 months ago)
• Language: JavaScript
• Homepage:
• Size: 17.6 KB
• Stars: 8
• Watchers: 8
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/Comcast/akamai-slack-reporter.svg?branch=master)](https://travis-ci.org/Comcast/akamai-slack-reporter)

# akamai-slack-reporter

A Slack slash command integration for querying your team's Akamai configuration.

## Installation

```

npm install akamai-slack-reporter

```

## Usage

Once deployed & configured, `akamai-slack-reporter` provides the following queries to your slash command integration:

```

# Available GTM traffic commands:

# https://developer.akamai.com/api/luna/config-gtm/overview.html

/slash-command domains

/slash-command domain 

/slash-command datacenters 

/slash-command datacenter  

/slash-command properties

/slash-command property  

# Available property commands:

# https://developer.akamai.com/api/luna/papi/overview.html

/slash-command groups

/slash-command products 

/slash-command hostnames  

/slash-command hostname   

/slash-command digitalproperties  

/slash-command digitalproperty   

/slash-command digitalpropertyversions   

```

## Deploying

Instantiate your `akamai-slack-reporter`:

```javascript

var AkamaiSlackReporter = require('akamai-slack-reporter'),

    reporter = new AkamaiSlackReporter({

      // NOTE: defaults to AKAMAI_EDGEGRID_CLIENT_TOKEN env var

      clientToken: '',

      // NOTE: defaults to AKAMAI_EDGEGRID_CLIENT_SECRET env var

      clientSecret: '',

      // NOTE: defaults to AKAMAI_EDGEGRID_ACCESS_TOKEN env var

      accessToken: '',

      // NOTE: defaults to AKAMAI_EDGEGRID_HOST env var

      host: '',

      // NOTE: defaults to SLACK_TOKEN env var

      slackToken: '',

      // NOTE: defaults to INCOMING_SLACK_WEB_HOOK_PATH env var

      hookPath: ''

    });

```

Next, deploy the `akamai-slack-reporter` instance to `some-url.com`.

Last, configure a Slack slash command integration to perform `POST` requests to

your `akamai-slack-reporter` instance at its `/integration` endpoint: `https://some-url.com/integration`

## Local development

```

npm install

npm test

```