0.0.0 • Published 7 years ago

xo-server-transport-slack v0.0.0

Weekly downloads
2
License
ISC
Repository
github
Last release
7 years ago

xo-server-transport-slack Build Status

xo-server plugin to send messages to Slack/Mattermost

Install

Installation of the npm package:

> npm install --global xo-server-transport-slack

Usage

Like all other xo-server plugins, it can be configured directly via the web iterface, see the plugin documentation. You can also test the configuration plugin if it works.

Slack

Generate the Webhook

  1. Log in your Slack team account
  2. Click on the Main menu at the top and choose Apps & Integrations

    Apps & Integrations

  3. Search Incoming WebHooks

    Incoming WebHooks

  4. Click on Add Configuration

    Add Configuration

  5. Choose the default channel and click on Add Incoming WebHooks integration

    Add Incoming WebHooks integration

  6. Modify the default settings and click on Save Settings

    Save Settings

Testing the plugin

Slack

Slack configuration

Slack

Mattermost

Mattermost configuration

Mattermost

Development

# Install dependencies
> npm install

# Run the tests
> npm test

# Continuously compile
> npm run dev

# Continuously run the tests
> npm run dev-test

# Build for production (automatically called by npm install)
> npm run build

### Xo#sendSlackMessage({ message })

This xo method is called to send the message passed in parameter to Slack or Mattermost.

Contributions

Contributions are very welcomed, either on the documentation or on the code.

You may:

  • report any issue you've encountered;
  • fork and create a pull request.

License

AGPL3 © Vates SAS