chat-adapter-lineworks

LINE WORKS adapter for Chat SDK.

Receive LINE WORKS Bot callbacks and send LINE WORKS text messages from Chat SDK handlers.

Alpha: this package is ready for early testing, but it has not yet been verified against every LINE WORKS callback and Bot API response shape.

Install

npm install chat chat-adapter-lineworks

Usage

import { Chat } from "chat";
import { createLineWorksAdapter } from "chat-adapter-lineworks";

const lineworks = createLineWorksAdapter({
  botId: process.env.LINEWORKS_BOT_ID!,
  botSecret: process.env.LINEWORKS_BOT_SECRET!,
  accessToken: process.env.LINEWORKS_ACCESS_TOKEN!,
});

const chat = new Chat({
  adapters: [lineworks],
});

Next.js App Router webhook

export async function POST(request: Request) {
  return lineworks.handleWebhook(request, {
    waitUntil: (task) => task.catch(console.error),
  });
}

The adapter verifies X-WORKS-BotId and X-WORKS-Signature before parsing JSON. The signature check uses the raw request body, not a parsed and re-stringified object.

Environment variables

createLineWorksAdapter() can read:

LINEWORKS_BOT_ID
LINEWORKS_BOT_SECRET
LINEWORKS_ACCESS_TOKEN
LINEWORKS_BOT_USER_NAME

See docs/setup.md for LINE WORKS callback and routing details.

Supported

• Callback signature verification.
• LINE WORKS message events with content.type === "text".
• Direct user messages and channel messages.
• postMessage() for LINE WORKS text messages.
• openDM() and isDM().
• Stable thread ID encode/decode.
• Basic HTTP error mapping.

Not supported yet

• Service Account JWT token acquisition.
• Files and attachments.
• Rich templates and button templates.
• Postback/action events.
• Message history fetching.
• Typing indicators.
• Message edit/delete.
• Reactions.

Thread IDs

Thread IDs represent the LINE WORKS destination, not message-level reply threads.

lineworks:user:{base64url(userId)}
lineworks:channel:{base64url(channelId)}

domainId is preserved in raw event metadata where available, but it is not encoded into the thread ID because LINE WORKS send endpoints route by botId plus userId or channelId.

Message behavior

• 1:1 messages are treated as mentions.
• Channel messages are not treated as mentions by default.
• Set treatChannelMessagesAsMentions: true if your bot should process all channel text messages.
• Non-text events are logged and ignored.
• Outbound text over 2,000 characters throws ValidationError instead of being split automatically.

Development

This package depends on Chat SDK primitives:

• chat is a peer dependency.
• @chat-adapter/shared provides shared adapter errors and helpers.
• LINE WORKS-specific API and webhook behavior lives in this package.

src/
  adapter.ts
  client.ts
  errors.ts
  factory.ts
  format-converter.ts
  index.ts
  signature.ts
  thread-id.ts
  token-provider.ts
  types.ts
  webhook.ts

License

MIT