georgediab:slack-notify

v0.1.0Published 10 years ago

This package has not had recent updates. Please investigate it's current state before committing to using it in your project.

Meteor package for slack-notify (https://github.com/andrewchilds/slack-notify)


Installation

First, install the slack-notify package from the command line:

mrt add slack-notify

Second, add your slack webhooks path to the settings.json file, create one if you don't already have one.

{
	"slack" : 'https://myaccountname.slack.com/services/hooks/incoming-webhook?token=myToken'
}

Uses

// 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: ':computer:', 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); };