PluginGatewayMessage
Interface: PluginGatewayMessage
Defined in: CodeBolt/packages/pluginSdk/src/modules/gateway.ts:19
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
agentId? | string | Which agent should handle this message | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:29 |
environmentId? | string | Optional environment to run agent in | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:31 |
externalThreadId? | string | External conversation/thread ID (for per-conversation strategy) | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:37 |
metadata? | Record<string, any> | Arbitrary metadata (platform name, sender info, attachments, etc.) | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:46 |
replyTo? | { channelId: string; externalThreadId?: string; pluginId?: string; userId?: string; } | Reply routing info — pluginId is auto-set by the server | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:39 |
replyTo.channelId | string | - | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:40 |
replyTo.externalThreadId? | string | - | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:41 |
replyTo.pluginId? | string | - | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:43 |
replyTo.userId? | string | - | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:42 |
source | "channel" | Always 'channel' for channel plugins | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:21 |
sourceId | string | Identifier for this channel source (e.g., 'plugin-telegram-channel') | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:23 |
text | string | The message text from the platform user | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:33 |
threadId? | string | Pre-resolved threadId (for 'existing' strategy) | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:27 |
threadStrategy | "single" | "per-user" | "per-conversation" | "per-message" | "existing" | How to resolve the thread | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:25 |
timestamp? | string | Timestamp of the original message | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:48 |
userId? | string | External user identifier (for per-user strategy) | CodeBolt/packages/pluginSdk/src/modules/gateway.ts:35 |