https://github.com/suttna/botbuilder-slack-extension

Slack extension for Microsoft BotBuilder. Deprecated use https://github.com/suttna/botbuilder-slack
https://github.com/suttna/botbuilder-slack-extension

botbuilder nodejs slack

Last synced: 1 day ago
JSON representation

Slack extension for Microsoft BotBuilder. Deprecated use https://github.com/suttna/botbuilder-slack

• Host: GitHub
• URL: https://github.com/suttna/botbuilder-slack-extension
• Owner: suttna
• License: mit
• Created: 2017-07-31T06:19:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-02T00:14:20.000Z (about 7 years ago)
• Last Synced: 2025-01-14T01:33:32.871Z (13 days ago)
• Topics: botbuilder, nodejs, slack
• Language: JavaScript
• Homepage: https://suttna.com
• Size: 43.9 KB
• Stars: 2
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![Logo](logo.png)

# botbuilder-slack-extension [![npm version](https://badge.fury.io/js/botbuilder-slack-extension.svg)](https://badge.fury.io/js/botbuilder-slack-extension) [![CircleCI](https://circleci.com/gh/suttna/botbuilder-slack-extension.svg?style=svg)](https://circleci.com/gh/suttna/botbuilder-slack-extension)

> ⚠️ **Deprecated** Use [botbuilder-slack](https://github.com/suttna/botbuilder-slack)

Slack extension for Microsoft BotBuilder.

This extension will listen for missing (in BotBuilder slack connector) events.

The following events are allowed and need to be configured in slack:

> Note: You need to manually add the events in this page: https://api.slack.com/apps/:APP_ID/event-subscriptions

## conversationUpdate

- channel_archive

- channel_created

- channel_deleted

- channel_rename

- channel_unarchive

- group_archive

- group_rename

- group_unarchive

## installationUpdate

- app_uninstalled

## slackCommand

You can listen for slack commands. Commands will be sent as custom events with type `slackCommand`. Event

information will be sent under `sourceEvent => SlackMessage`.

## Install

```

yarn add botbuilder-slack-extension

```

## Usage

The extension will listen for the previously listed slack events and forward them as `conversationUpdate` events.

This means you can use:

```javascript

 bot.on('event', function(event) {

  // Handle event here

 })

 bot.on('slackCommand', function(event) {

  // If you want to use slack commands

 })

```

To configure the extension you simply need to create a listener and hook it in your restify server.

```javascript

var restify = require('restify')

var builder = require('botbuilder')

var SlackEventListener = require('botbuilder-slack-extension')

var connector = new builder.ChatConnector()

var bot = new builder.UniversalBot(connector)

// SlackEventListener take two arguments, the chat connector and a lookup function for your bot.

// The lookup function must return a promise with an object that conforms to IIdentity

var slackEventListener = new SlackEventListener(connector, function (teamId) {

  return new Promise(function (resolve, reject) {

    // This is your custom get function

    const bot = getBot(teamId)

    return { id: bot.id, name: bot.name }

  })

})

// Start listenting for botbuilder events

server.post('/bot', dependencies.botConnector.listen())

// Start listenting for direct slack events

server.post('/your-slack-path-for-events', slackEventListener.webhooksHandler())

// Start listenting for slack commands

server.post('/your-slack-path-for-commands', slackEventListener.commandsHandler())

```

## Contact

- Martín Ferández 

- Santiago Doldán