botpress-channel-rocketchat

!botpress-rocketchat

Official Rocket.Chat connector module for Botpress.

This module has been build to accelerate and facilitate development of Rocket.Chat bots.

This module is tested and working using version 10.34.0 of botpress.

Installation

* Create a new botpress bot:

``sh
botpress init
`

* Install your bot dependencies:

`sh
npm install
`

* Install this module:

`sh
npm install botpress-channel-rocketchat
`

* Update the file config/channel-rocketchat.json with your bot data:

`json
{
"ROCKETCHAT_USER": "botpress",
"ROCKETCHAT_PASSWORD": "botpress",
"ROCKETCHAT_URL": "http://localhost:3001",
"ROCKETCHAT_USE_SSL": "false",
"ROCKETCHAT_ROOM": "GENERAL",
"scope": ""
}
`

* Start your bot.

`sh
botpress start
`

Get started

To setup connexion of your chatbot to Rocket.Chat follow this steps:

* Follow the Rocket.Chat Deployment documentation:

Deployment

* If you are in a development environment up a docker instance of Rocket.Chat,
see how to make it in our example repository:

botpress-kick-starter

* Login with your user;

* Create a new user for your bot;

* Add your bot to wanted channels;

Features

$3

* Profile
* Text messages

$3

* Text messages

Reference

$3

You can listen to incoming event easily with Botpress by using bp built-in hear function. You only need to listen to specific Rocket.Chat event to be able to react to user's actions.

`js
bp.hear({platform:'rocketchat', type: 'message', text:'hello'}, async (event, next) => {
await bp.rocketchat.sendMessage(event.channel, 'Hi I\'m alive', {})
next()
})
`

In fact, this module preprocesses messages and send them to incoming middlewares. When you build a bot or a module, you can access to all information about incoming messages that have been send to middlewares.

All your flow implementation will work with Rocket.Chat too.

`js
await bp.middlewares.sendIncoming({
platform: 'rocketchat',
type: 'message',
text: message.msg,
user: user,
channel: message.rid,
ts: message.ts.$date,
direct: false,
roomType: meta.roomType,
raw: message
})
`

#### Profile

You can acces to all user's profile information by using this module. A cache have been implemented to fetch all information about users and this information is sent to middlewares.

`js
{
id: id,
userId: userId,
username: message.u.username,
platform: 'rocketchat',
first_name: message.u.name,
number: userId
}
`

Note: All new users are automatically saved by this module in Botpress built-in database (bp.db).

#### Text messages

An event is sent to middlewares for each incoming text message from Rocket.Chat platform with all specific information.

`js
{
platform: 'rocketchat',
type: 'message',
text: message.msg,
user: user,
channel: message.rid,
ts: message.ts.$date,
direct: false,
roomType: meta.roomType,
raw: message
}
`

Then, you can listen easily to this event in your module or bot

`js
bp.hear('hello')
`

$3

By using our module, you can send any text or attachment you want to your users on Rocket.Chat.

$3

In code, it is simple to send a message text to a specific users or channels.

#### sendMessage(msg, options, event) -> Promise

##### Arguments

1. msg (_String_ / _Object_): Message that will be send to user.

2. options (_Object_): Needed options.

3. event (_Object_): Contain the message, user and options data.

#### Save users in Database

Users are automatically persisted in the built-in botpress database using the built-in bp.db.saveUser` function.

$3

There's a Rocket.Chat where you are welcome to join us, ask any question and even help others.

Check our repositories too:

botpress-kick-start

botpress-channel-rocketchat

$3

botpress-rocketchat is licensed under AGPL-3.0