mattermost-api
v1.0.1
Published
Mattermost api library for node.js. Get notification when error or message arrive.
Downloads
7
Maintainers
Readme
Overview
mattermost-api library is used for track node js error in mattermost and also used for custom message
Version
V1.0.1
Use
npm install mattermost-api --save
var Mattermost = require("mattermost-api");
const express = require('express');
var app = express();
If you set mattermost_webhook_url error message will throw in error in webhook url's channel
app.use(Mattermost({
'url': 'mattermost_webhook_url',
'username': 'Username which display on your mattermost channel',
'icon_url':'URL',
'userid': 'userid',
'password': 'password',
'mattermosturl': 'your mattermost URL(Host)',
'channelid': 'channelid'
}));
For send custom message
Mattermost.sendmsg('your message');
If you want to use custom channel for send message pass option in second parameter url and username. If you pass this parameter library will use passed parameter other wise it will use set parameter for error.
Mattermost.sendmsg('your message', {
'url': 'mattermost_webhook_url',(optional or use set parameter for error)
'username': 'Username which display on your mattermost channel',(optional or use set parameter for error)
'icon_url':'URL'(optional if you want to diffrent icon then you set in error)
'image_url':'URL'(optional if you want to attach image)
});
For send message by user which you set for error message
Mattermost.sendmsgByUser('your message');
Also you can send message with diffrent user
Mattermost.sendmsgByUser('your message', {
userid: 'userid',(optional or use set parameter for error)
password: 'password',(optional or use set parameter for error)
mattermosturl: 'your mattermost URL',(optional or use set parameter for error)
channelid: 'channelid',(optional or use set parameter for error)
file: Buffer data, data must be Buffer (optional if you want to upload file)
filename: 'filename'(must use with file)
image_url:'URL'(optional if you want to attach image)
});
License
This project is licensed under the MIT License - see the license.md file for details