This is a Slack integration client for rockets/rockets.

Installation

1npm install rockets-slack

Usage

1var Client = require('rockets-slack');
2
3// Integration configuration.
4var config = {
5
6    // Slack webhook URL
7    webhook: "https://hooks.slack.com/services/*/*/*",
8
9    // Channel subscriptions
10    channels: {
11        
12        // Configuration for post events (optional)
13        posts: {
14
15            // Highlight color in Slack for posts
16            color: "#ff4500",
17
18            // Filtering rules for posts
19            exclude: {},
20            include: {
21                contains: [
22                    "abc",
23                ]
24            },
25        },
26
27        // Configuration for comment events (optional)
28        comments: {
29
30            // Highlight color in Slack for comments
31            color: "#336699",
32
33            // Filtering rules for comments
34            exclude: {},
35            include: {
36                contains: [
37                    "xyz",
38                ]
39            },
40        },
41    }
42};
43
44// Create a new client using the configuration. You can create mutliple clients if you have more than one configuration.
45var client = new Client(config);
46
47// Establish a connection and start listening for events.
48client.run();

Filters

See rockets/rockets for a complete list of filtering rules.

Warning: if no rules are specified, all models will be included.

Credits

Illustrations by Ken Samonte.