slack-notify
A simple, flexible Node.js wrapper around the Slack webhook API. Makes it easy to send notifications to Slack from your application.
Installation
npm install slack-notify
Usage
var MY_SLACK_WEBHOOK_URL = 'https://myaccountname.slack.com/services/hooks/incoming-webhook?token=myToken';
var slack = require('slack-notify')(MY_SLACK_WEBHOOK_URL);
slack.bug('Something bad happened!');
slack.success('Something good happened!');
slack.alert('Something important happened!');
slack.note('Here is a note.');
slack.alert({
text: 'Current server stats',
fields: {
'CPU usage': '7.51%',
'Memory usage': '254mb'
}
});
slack.alert({
text: 'Current server stats',
attachments: [
{
fallback: 'Required Fallback String',
fields: [
{ title: 'CPU usage', value: '7.51%', short: true },
{ title: 'Memory usage', value: '254mb', short: true }
]
}
]
});
slack.send({
channel: '#myCustomChannelName',
icon_url: 'http://example.com/my-icon.png',
text: 'Here is my notification',
unfurl_links: 1,
username: 'Jimmy'
});
var statLog = slack.extend({
channel: '#statistics',
icon_emoji: ':computer:',
username: 'Statistics'
});
statLog({
text: 'Current server statistics',
fields: {
'CPU usage': '7.51%',
'Memory usage': '254mb'
}
});
slack.alert('Hello', function (err) {
if (err) {
console.log('API error:', err);
} else {
console.log('Message received!');
}
});
slack.onError = function (err) {
console.log('API error:', err);
};
Running the Test Suite
npm install
npm test
License
MIT. Copyright © 2014 Andrew Childs