slack-notify

A simple, flexible, zero-dependency Node.js wrapper around the Slack webhook API. Makes it easy to send notifications to Slack from your application.

Installation

1npm install slack-notify

Usage

1
2// Import module:
3
4import SlackNotify from 'slack-notify';
5const MY_SLACK_WEBHOOK_URL = 'https://hooks.slack.com/services/RANDOMCHARS';
6const slack = SlackNotify(MY_SLACK_WEBHOOK_URL);
7
8// Example sending just text, using the Slack-provided configuration:
9
10slack.send('Hello!')
11  .then(() => {
12    console.log('done!');
13  }).catch((err) => {
14    console.error(err);
15  });
16
17// The Slack-provided configuration can be overridden:
18
19slack.send({
20  channel: '#myCustomChannelName',
21  icon_url: 'http://example.com/my-icon.png',
22  text: 'Here is my notification',
23  unfurl_links: 1,
24  username: 'Jimmy'
25});
26
27// Roll your own notification type:
28
29var statLog = slack.extend({
30  channel: '#statistics',
31  icon_emoji: ':computer:',
32  username: 'Statistics'
33});
34
35statLog({
36  text: 'Current server statistics',
37  fields: {
38    'CPU usage': '7.51%',
39    'Memory usage': '254mb'
40  }
41});
42
43// Promises are supported:
44
45slack.send('Hello!').then(() => {
46  console.log('Done!');
47}).catch((err) => {
48  console.error('API error:', err);
49})
50
51// Three pre-configured methods are provided:
52
53// Posts to #bugs by default:
54slack.bug('Something broke!');
55
56// Posts to #alerts by default:
57slack.success('Something happened correctly!');
58slack.alert('Something important!');
59
60// Send custom fields which are nicely displayed by the Slack client:
61
62slack.alert({
63  text: 'Current server stats',
64  fields: {
65    'CPU usage': '7.51%',
66    'Memory usage': '254mb'
67  }
68});
69
70// The `fields` object is custom shorthand for the `attachments` array, which is also supported.
71
72slack.alert({
73  text: 'Current server stats',
74  attachments: [
75    {
76      fallback: 'Required Fallback String',
77      fields: [
78        { title: 'CPU usage', value: '7.51%', short: true },
79        { title: 'Memory usage', value: '254mb', short: true }
80      ]
81    }
82  ]
83});
84
85// Set slack message color
86
87slack.alert({
88  text: 'Current server stats',
89  attachments: [
90    {
91      fallback: 'Required Fallback String',
92      color: '#FF0000',
93      fields: [
94        { title: 'CPU usage', value: '90%', short: true },
95        { title: 'Memory usage', value: '254mb', short: true }
96      ]
97    }
98  ]
99});
100

Running the Test Suite

1npm install
2npm test

CJS / ESM support

This library supports CommonJS and ES Modules.

1// Require as Common JS:
2const SlackNotify = require('slack-notify');
3
4// Import as ES Module:
5import SlackNotify from 'slack-notify';
6
7// Either:
8const slack = SlackNotify(MY_SLACK_WEBHOOK_URL);

License

MIT. Copyright © 2014-2023 Andrew Childs