Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Channel ingress API

Channel ingress is the experimental access-control boundary for inbound channel events. Use openclaw/plugin-sdk/channel-ingress-runtime for receive paths. The older openclaw/plugin-sdk/channel-ingress subpath stays exported as a deprecated compatibility facade for third-party plugins. Plugins own platform facts and side effects. Core owns generic policy: DM/group allowlists, pairing-store DM entries, route gates, command gates, event auth, mention activation, redacted diagnostics, and admission.

​
Runtime Resolver

import {
  defineStableChannelIngressIdentity,
  resolveChannelMessageIngress,
} from "openclaw/plugin-sdk/channel-ingress-runtime";

const identity = defineStableChannelIngressIdentity({
  key: "platform-user-id",
  normalize: normalizePlatformUserId,
  sensitivity: "pii",
});

const result = await resolveChannelMessageIngress({
  channelId: "my-channel",
  accountId,
  identity,
  subject: { stableId: platformUserId },
  conversation: { kind: isGroup ? "group" : "direct", id: conversationId },
  event: { kind: "message", authMode: "inbound", mayPair: !isGroup },
  policy: {
    dmPolicy: config.dmPolicy,
    groupPolicy: config.groupPolicy,
    groupAllowFromFallbackToAllowFrom: true,
  },
  allowFrom: config.allowFrom,
  groupAllowFrom: config.groupAllowFrom,
  accessGroups: cfg.accessGroups,
  route,
  readStoreAllowFrom,
  command: hasControlCommand ? { allowTextCommands: true, hasControlCommand } : undefined,
});
Do not precompute effective allowlists, command owners, or command groups. The resolver derives them from raw allowlists, store callbacks, route descriptors, access groups, policy, and conversation kind.

​
Result

Bundled plugins should consume modern projections directly:
  • ingress: ordered gate decision and admission
  • senderAccess: sender/conversation authorization only
  • routeAccess: route and route-sender projection
  • commandAccess: command authorization; false when no command gate ran
  • activationAccess: mention/activation result
Event authorization remains available on the ordered ingress.graph and the decisive ingress.reasonCode; no separate event projection is emitted. Deprecated third-party SDK helpers may rebuild older shapes internally. New bundled receive paths should not translate modern results back into local DTOs.

​
Access Groups

accessGroup:<name> entries stay redacted. Core resolves static message.senders groups itself and calls resolveAccessGroupMembership only for dynamic groups that require a platform lookup. Missing, unsupported, and failed groups fail closed.

​
Event Modes

authModeMeaning
inboundnormal inbound sender gates
commandcommand gates for callbacks or scoped buttons
origin-subjectactor must match the original message subject
route-onlyroute gates only for route-scoped trusted events
noneplugin-owned internal events bypass shared auth
Use mayPair: false for reactions, buttons, callbacks, and native commands.

​
Routes And Activation

Use route descriptors for room, topic, guild, thread, or nested route policy: 
route: {
  id: "room",
  allowed: roomAllowed,
  enabled: roomEnabled,
  senderPolicy: "replace",
  senderAllowFrom: roomAllowFrom,
  blockReason: "room_sender_not_allowlisted",
}
Use channelIngressRoutes(...) when a plugin has several optional route descriptors; it filters disabled branches while keeping route facts generic and ordered by each descriptor’s precedence. Mention gating is an activation gate. A mention miss returns admission: "skip" so the turn kernel does not process an observe-only turn. Most channels should leave activation after sender and command gates. Public chat surfaces that must quiet non-mentioned traffic before sender allowlist noise can opt into activation.order: "before-sender" when text-command bypass is disabled. Channels with implicit activation, such as replies in bot threads, can pass activation.allowedImplicitMentionKinds; the projected activationAccess.shouldBypassMention then reports when command or implicit activation bypassed an explicit mention.

​
Redaction

Raw sender values and raw allowlist entries are resolver input only. They must not appear in resolved state, decisions, diagnostics, snapshots, or compatibility facts. Use opaque subject ids, entry ids, route ids, and diagnostic ids.

​
Verification

pnpm test src/channels/message-access/message-access.test.ts src/plugin-sdk/channel-ingress-runtime.test.ts
pnpm plugin-sdk:api:check