# slackbots > Simple API for Slack Latest version **1.3.0** (published 2022-10-02) · MIT license · 0 weekly downloads ## Install ```sh npm install slackbots pnpm add slackbots yarn add slackbots bun add slackbots ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.3.0 | | Published | 2022-10-02 | | First published | 2015-06-04 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 6 | | Unpacked size | 28.1 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 1340 | | Author | Mikhail Mokrushin | | Maintainers | mishk0 | ## Links - npm: https://www.npmjs.com/package/slackbots - Repository: https://github.com/mishk0/slack-bot-api - Issues: https://github.com/mishk0/slack-bot-api/issues - npm.io page: https://npm.io/package/slackbots ## Dependencies (6) - [ws](https://npm.io/package/ws.md) ^7.1.1 - [vow](https://npm.io/package/vow.md) ^0.4.20 - [extend](https://npm.io/package/extend.md) ^3.0.2 - [lodash](https://npm.io/package/lodash.md) ^4.17.15 - [request](https://npm.io/package/request.md) ^2.88.0 - [ws-heartbeat](https://npm.io/package/ws-heartbeat.md) ^1.1.0 ## Recent versions - 1.3.0 (latest) — 2022-10-02 - 1.2.0 — 2018-10-17 - 1.1.0 — 2017-09-15 - 1.0.2 — 2016-12-22 - 1.0.1 — 2016-12-18 - 0.5.3 — 2016-10-09 - 0.5.2 — 2016-08-07 - 0.5.1 — 2016-01-14 - 0.5.0 — 2015-11-22 - 0.4.0 — 2015-09-06 - 0.3.0 — 2015-06-09 - 0.2.1 — 2015-06-08 - 0.2.0 — 2015-06-06 - 0.1.0 — 2015-06-04 ## README # SlackBots.js [![license](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/mishk0/slack-bot-api/master/LICENSE) [![Build Status](https://travis-ci.org/mishk0/slack-bot-api.svg?branch=master)](https://travis-ci.org/mishk0/slack-bot-api) [![npm](https://img.shields.io/npm/v/slackbots.svg?style=flat)](https://www.npmjs.com/package/slackbots) This is Node.js library for easy operation with Slack API. It also exposes all opportunities of Slack's Real Time Messaging API. ## Installation ``` npm install slackbots ``` ### Params - `token` (string) the slack token - `name` (string) the name of the bot - `disconnect` (boolean, defaults: `false`) whether to open websocket connection to listen to incoming messages, set to `true` for one time use ### Events - `start` - event fired, when Real Time Messaging API is started (via websocket), - `message` - event fired, when something happens in Slack. Description of all events here, - `open` - websocket connection is open and ready to communicate, - `close` - websocket connection is closed. - `error` - an error occurred while connecting to Slack ### Methods - `getChannels()` (return: promise) - returns a list of all channels in the team, - `getGroups()` (return: promise) - returns a list of all groups in the team, - `getUsers()` (return: promise) - returns a list of all users in the team, - `getImChannels()` (return: promise) - returns a list of bots direct message channels in the team, - `getChannel(name)` (return: promise) - gets channel by name, - `getGroup(name)` (return: promise) - gets group by name, - `getUser(name)` (return: promise) - gets user by name, - `getUserByEmail(name)` (return: promise) - gets user by name, - `getChannelId(name)` (return: promise) - gets channel ID by name, - `getGroupId(name)` (return: promise) - gets group ID by name, - `getUserId(name)` (return: promise) - gets user ID by name, - `getChatId(name)` (return: promise) - it returns or opens and returns a direct message channel ID, - `postEphemeral(id, user, text, params)` (return: promise) - posts an ephemeral message to channel and user by ID, - `postMessage(id, text, params)` (return: promise) - posts a message to channel | group | user by ID, - `updateMessage(channelId, timestamp, text, params)` (return: promise) - updates a message in a channel, - `postTo(name, message [, params, callback])` (return: promise) - posts a message to channel | group | user by name, - `postMessageToUser(name, message [, params, callback])` (return: promise) - posts a direct message by user name, - `postMessageToGroup(name, message [, params, callback])` (return: promise) - posts a message to private group by name, - `postMessageToChannel(name, message [, params, callback])` (return: promise) - posts a message to channel by name. - `openIm(userId)` (return: promise) - opens a direct message channel with another member in the team ## Usage ```js var SlackBot = require('slackbots'); // create a bot var bot = new SlackBot({ token: 'xoxb-012345678-ABC1DFG2HIJ3', // Add a bot https://my.slack.com/services/new/bot and put the token name: 'My Bot' }); bot.on('start', function() { // more information about additional params https://api.slack.com/methods/chat.postMessage var params = { icon_emoji: ':cat:' }; // define channel, where bot exist. You can adjust it there https://my.slack.com/services bot.postMessageToChannel('general', 'meow!', params); // define existing username instead of 'user_name' bot.postMessageToUser('user_name', 'meow!', params); // If you add a 'slackbot' property, // you will post to another user's slackbot channel instead of a direct message bot.postMessageToUser('user_name', 'meow!', { 'slackbot': true, icon_emoji: ':cat:' }); // define private group instead of 'private_group', where bot exist bot.postMessageToGroup('private_group', 'meow!', params); }); ``` PROFIT! ```js /** * @param {object} data */ bot.on('message', function(data) { // all ingoing events https://api.slack.com/rtm console.log(data); }); ``` ### Response Handler The simplest way for handling response is callback function, which is specified as a last argument: ```js bot.postMessageToUser('user1', 'hi', function(data) {/* ... */}); bot.postMessageToUser('user1', 'hi', params, function(data) {/* ... */}); ``` But also you can use promises. Error: ```js bot.postMessageToUser('user1', 'hi').fail(function(data) { //data = { ok: false, error: 'user_not_found' } }) ``` Success: ```js bot.postMessageToUser('user', 'hi').then(function(data) { // ... }) ``` Error and Success: ```js bot.postMessageToUser('user', 'hi').always(function(data) { // ... }) ``` --- _Source: https://npm.io/package/slackbots · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._