Package Exports
- slack-notify
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (slack-notify) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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
// Require module:
var MY_SLACK_WEBHOOK_URL = 'https://myaccountname.slack.com/services/hooks/incoming-webhook?token=myToken';
var slack = require('slack-notify')(MY_SLACK_WEBHOOK_URL);
// Bundled notification types:
slack.bug('Something bad happened!'); // Posts to #bugs by default
slack.success('Something good happened!'); // Posts to #alerts by default
slack.alert('Something important happened!'); // Posts to #alerts by default
slack.note('Here is a note.'); // Posts to #alerts by default
// Send custom fields which are nicely displayed by the Slack client:
slack.alert({
text: 'Current server stats',
fields: {
'CPU usage': '7.51%',
'Memory usage': '254mb'
}
});
// The `fields` object is custom shorthand for the `attachments` array:
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 }
]
}
]
});
// Everything is overridable:
slack.send({
channel: '#myCustomChannelName',
icon_url: 'http://example.com/my-icon.png',
text: 'Here is my notification',
unfurl_links: 1,
username: 'Jimmy'
});
// Roll your own notification type:
var statLog = slack.extend({
channel: '#statistics',
icon_emoji: '💻',
username: 'Statistics'
});
statLog({
text: 'Current server statistics',
fields: {
'CPU usage': '7.51%',
'Memory usage': '254mb'
}
});
// Callbacks and a generic onError function are supported:
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
Contributors
License
MIT. Copyright © 2014 Andrew Childs