txinbot

library1.1.17jsnpmunverified

OpenClaw channel plugin for Txin Bot integration via WebSocket. Current version 1.1.17. Provides bidirectional communication, automatic reconnection with exponential backoff, heartbeat mechanism, message queuing, and support for text, image, and file messages. Primarily a plugin for the OpenClaw framework; not a standalone library. Requires an API key from Txin Bot service.

communication

npm install txinbot

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · TXINBOT

txinbot

communicationjavascriptv1.1.17

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import TxinBotPlugin from '@exonis/txinbot'

✗ const TxinBotPlugin = require('@exonis/txinbot')

Package ships TypeScript types and is ESM-only; CJS require() will cause errors.

MessageType

✓ import { MessageType } from '@exonis/txinbot'

✗ import { MessageTypes } from '@exonis/txinbot'

Named export is `MessageType` (singular), not `MessageTypes`.

TxinBotOptions

✓ import type { TxinBotOptions } from '@exonis/txinbot'

✗ import { TxinBotOptions } from '@exonis/txinbot'

TxinBotOptions is a TypeScript type, not a runtime value. Use `import type` to avoid bundling issues.

Initializes the TxinBot plugin with an API key and WebSocket URL, then registers it with an OpenClaw instance.

import TxinBotPlugin from '@exonis/txinbot'; import { OpenClaw } from 'openclaw'; const bot = new OpenClaw(); await bot.use(new TxinBotPlugin({ token: process.env.TXINBOT_API_KEY ?? 'YOUR_API_KEY', wsUrl: process.env.TXINBOT_WS_URL ?? 'ws://localhost:9090/ws' })); export default bot;

Debug

Known issues

gotchaPlugin requires OpenClaw v1.5.0 or later – earlier versions do not support channel plugins.

fix

Upgrade OpenClaw to v1.5.0+ with `npm update openclaw`.

affects: <1.5.0

gotchaDefault WebSocket URL is ws://localhost:9090/ws – not for production. Must set TXINBOT_WS_URL or plugin config.

fix

Set `TXINBOT_WS_URL` environment variable or pass `wsUrl` in constructor options.

affects: >=1.0.0

gotchaAPI key is required – either passed as token option or via TXINBOT_API_KEY env var. Plugin will fail to connect without it.

fix

Add `--token 'YOUR_API_KEY'` when running `openclaw channels add` or set `TXINBOT_API_KEY` environment variable.

affects: >=1.0.0

deprecatedAutomatic reconnection uses exponential backoff with a maximum of 5 retries. This behavior may change in future versions.

fix

No action needed; be aware of potential changes when upgrading.

affects: >=1.0.0 <2.0.0

Errors

Common errors & fixes

Error: Plugin 'txinbot' not found. Make sure it is installed correctly.

Plugin not installed via OpenClaw CLI or missing from node_modules.

fix

Run `openclaw plugins install txinbot@latest` in your project directory.

WebSocket connection error: connect ECONNREFUSED ::1:9090

Txin Bot server not running or incorrect WebSocket URL.

fix

Start the Txin Bot server on ws://localhost:9090/ws or set TXINBOT_WS_URL to the correct URL.

Connection closed with code 4001: Invalid authentication token.

API key is invalid or expired.

fix

Verify the API key and set it via the --token flag or environment variable TXINBOT_API_KEY.

Upgrade

Version history

1.1.17latest on npm

Audit

Dependencies

openclawrequiredPlugin runtime dependency – requires OpenClaw installed and configured to run

Agent activity

28 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/exonis/txinbot-plugin ↗

packagetxinbot ↗

homepagehttps://github.com/exonis/txinbot-plugin#readme ↗