@cortex-mesh/openclaw-rocketchat
v1.3.2
Published
Rocket.Chat channel plugin for OpenClaw
Maintainers
Readme
OpenClaw Rocket.Chat Plugin
A Rocket.Chat channel plugin for OpenClaw. Polls Rocket.Chat channels for new messages, dispatches them through the OpenClaw agent system, and sends responses back — with reaction feedback (hourglass on start, checkmark on success, x on failure).
Requirements
- Node.js >= 22
- OpenClaw >= 2026.2.0
- A Rocket.Chat instance with API access
Installation
npm install @cortex-mesh/openclaw-rocketchatConfiguration
Add to your ~/.openclaw/openclaw.json:
{
"channels": {
"rocketchat": {
"enabled": true,
"url": "http://your-rocketchat:3000",
"authToken": "your-auth-token",
"userId": "your-user-id",
"channel": "your-channel-name",
"botUsername": "your-bot-username",
"pollInterval": 2
}
},
"plugins": {
"allow": ["rocketchat"],
"load": {
"paths": ["/path/to/openclaw-rocketchat"]
},
"entries": {
"rocketchat": { "enabled": true }
}
}
}Getting Rocket.Chat Credentials
- Log in to your Rocket.Chat instance
- Go to My Account > Personal Access Tokens
- Create a new token — copy the User Id and Token values
- Use these as
userIdandauthTokenin the config
Config Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| url | string | required | Rocket.Chat server URL |
| authToken | string | required | Personal access token |
| userId | string | required | User ID for the bot account |
| channel | string | required | Channel name to monitor (without #) |
| botUsername | string | — | Bot's username (for display) |
| pollInterval | number | 2 | Polling interval in seconds |
How It Works
Rocket.Chat channel
↓ poll every 2s
[Plugin monitors channel history]
↓ new message detected
[Add hourglass reaction]
↓
[Dispatch to OpenClaw agent]
↓ agent responds
[Send reply to channel/thread]
↓
[Replace hourglass with checkmark (or x on error)]The plugin:
- Polls the configured channel for new messages
- Skips its own messages, system messages, and bot messages
- Adds an hourglass reaction when processing starts
- Routes messages through OpenClaw's agent system
- Replies in the same thread (or creates a new thread)
- Replaces hourglass with checkmark on success, x on failure
Development
# Run tests
npm test
# Run tests in watch mode
npm run test:watchLicense
MIT
