​

Створення плагінів каналів

​

Як працюють плагіни каналів

• Конфігурація — визначення облікового запису та майстер налаштування
• Безпека — політика DM та allowlist-и
• Парування — процес підтвердження DM
• Граматика сесій — як conversation id, специфічні для провайдера, зіставляються з базовими чатами, id потоків і резервними батьківськими значеннями
• Вихідні повідомлення — надсилання тексту, медіа та опитувань на платформу
• Потоковість — як упорядковуються відповіді

​

Погодження та можливості каналів

• Core керує /approve у тому самому чаті, спільними payload-ами кнопок погодження та загальною резервною доставкою.
• Віддавайте перевагу одному об’єкту approvalCapability у плагіні каналу, коли каналу потрібна поведінка, специфічна для погоджень.
• approvalCapability.authorizeActorAction і approvalCapability.getActionAvailabilityState — це канонічний шар авторизації погоджень.
• Якщо ваш канал надає нативні погодження exec, реалізуйте approvalCapability.getActionAvailabilityState навіть якщо нативний транспорт повністю живе в approvalCapability.native. Core використовує цей хук доступності, щоб розрізняти enabled і disabled, визначати, чи підтримує ініціюючий канал нативні погодження, і включати канал до підказок резервного сценарію для нативного клієнта.
• Використовуйте outbound.shouldSuppressLocalPayloadPrompt або outbound.beforeDeliverPayload для поведінки життєвого циклу payload-ів, специфічної для каналу, наприклад приховування дубльованих локальних prompt-ів погодження або надсилання індикаторів набору тексту перед доставкою.
• Використовуйте approvalCapability.delivery лише для нативної маршрутизації погоджень або придушення резервного сценарію.
• Використовуйте approvalCapability.render лише тоді, коли каналу справді потрібні власні payload-и погодження замість спільного рендерера.
• Використовуйте approvalCapability.describeExecApprovalSetup, коли канал хоче, щоб відповідь у гілці disabled пояснювала точні параметри конфігурації, потрібні для ввімкнення нативних погоджень exec. Хук отримує { channel, channelLabel, accountId }; канали з іменованими обліковими записами мають рендерити шляхи, прив’язані до облікового запису, наприклад channels.<channel>.accounts.<id>.execApprovals.*, замість значень верхнього рівня за замовчуванням.
• Якщо канал може вивести стабільні DM-ідентичності, подібні до власника, із наявної конфігурації, використовуйте createResolvedApproverActionAuthAdapter з openclaw/plugin-sdk/approval-runtime, щоб обмежити /approve у тому самому чаті без додавання логіки погоджень, специфічної для core.
• Якщо каналу потрібна нативна доставка погоджень, тримайте код каналу зосередженим на нормалізації цілі та транспортних хуках. Використовуйте createChannelExecApprovalProfile, createChannelNativeOriginTargetResolver, createChannelApproverDmTargetResolver, createApproverRestrictedNativeApprovalCapability і createChannelNativeApprovalRuntime з openclaw/plugin-sdk/approval-runtime, щоб core керував фільтрацією запитів, маршрутизацією, дедуплікацією, строком дії та підпискою gateway.
• Канали з нативними погодженнями мають маршрутизувати і accountId, і approvalKind через ці хелпери. accountId зберігає політику погоджень для кількох облікових записів у межах правильного облікового запису бота, а approvalKind зберігає поведінку погоджень exec і плагінів доступною для каналу без жорстко закодованих гілок у core.
• Зберігайте тип id доставленого погодження від початку до кінця. Нативні клієнти не повинні вгадувати або переписувати маршрутизацію погоджень exec чи плагінів на основі локального стану каналу.
• Різні типи погоджень можуть навмисно відкривати різні нативні поверхні. Поточні приклади вбудованих плагінів:
  • Slack зберігає доступність нативної маршрутизації погоджень як для id exec, так і для id плагінів.
  • Matrix зберігає нативну маршрутизацію DM/каналів лише для погоджень exec і залишає погодження плагінів на спільному шляху /approve у тому самому чаті.
• createApproverRestrictedNativeApprovalAdapter усе ще існує як обгортка сумісності, але новий код має віддавати перевагу побудовнику можливостей і надавати approvalCapability у плагіні.

• openclaw/plugin-sdk/approval-auth-runtime
• openclaw/plugin-sdk/approval-client-runtime
• openclaw/plugin-sdk/approval-delivery-runtime
• openclaw/plugin-sdk/approval-native-runtime
• openclaw/plugin-sdk/approval-reply-runtime

• openclaw/plugin-sdk/setup-runtime охоплює безпечні для runtime хелпери setup: безпечні для import адаптери патчів setup (createPatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator), вивід приміток пошуку, promptResolvedAllowFrom, splitSetupEntries і делеговані побудовники proxy для setup
• openclaw/plugin-sdk/setup-adapter-runtime — це вузький env-aware шар адаптера для createEnvPatchedAccountSetupAdapter
• openclaw/plugin-sdk/channel-setup охоплює побудовники setup для необов’язкового встановлення, а також кілька безпечних для setup примітивів: createOptionalChannelSetupSurface, createOptionalChannelSetupAdapter, createOptionalChannelSetupWizard, DEFAULT_ACCOUNT_ID, createTopLevelChannelDmPolicy, setSetupChannelEnabled і splitSetupEntries
• використовуйте ширший шар openclaw/plugin-sdk/setup лише тоді, коли вам також потрібні важчі спільні хелпери setup/config, наприклад moveSingleAccountChannelSectionToDefaultAccount(...)

• openclaw/plugin-sdk/account-core, openclaw/plugin-sdk/account-id, openclaw/plugin-sdk/account-resolution і openclaw/plugin-sdk/account-helpers для конфігурації кількох облікових записів і резервного повернення до облікового запису за замовчуванням
• openclaw/plugin-sdk/inbound-envelope і openclaw/plugin-sdk/inbound-reply-dispatch для маршрутизації/конвертів вхідних повідомлень і зв’язування record-and-dispatch
• openclaw/plugin-sdk/messaging-targets для розбору/зіставлення цілей
• openclaw/plugin-sdk/outbound-media і openclaw/plugin-sdk/outbound-runtime для завантаження медіа та делегатів ідентичності/надсилання вихідних повідомлень
• openclaw/plugin-sdk/thread-bindings-runtime для життєвого циклу прив’язок потоків і реєстрації адаптерів
• openclaw/plugin-sdk/agent-media-payload лише тоді, коли все ще потрібна застаріла структура полів payload-ів agent/media
• openclaw/plugin-sdk/telegram-command-config для нормалізації користувацьких команд Telegram, валідації дублікатів/конфліктів і стабільного як резервний варіант контракту конфігурації команд

​

Покрокове проходження

{
  "name": "@myorg/openclaw-acme-chat",
  "version": "1.0.0",
  "type": "module",
  "openclaw": {
    "extensions": ["./index.ts"],
    "setupEntry": "./setup-entry.ts",
    "channel": {
      "id": "acme-chat",
      "label": "Acme Chat",
      "blurb": "Connect OpenClaw to Acme Chat."
    }
  }
}

import {
  createChatChannelPlugin,
  createChannelPluginBase,
} from "openclaw/plugin-sdk/channel-core";
import type { OpenClawConfig } from "openclaw/plugin-sdk/channel-core";
import { acmeChatApi } from "./client.js"; // your platform API client

type ResolvedAccount = {
  accountId: string | null;
  token: string;
  allowFrom: string[];
  dmPolicy: string | undefined;
};

function resolveAccount(
  cfg: OpenClawConfig,
  accountId?: string | null,
): ResolvedAccount {
  const section = (cfg.channels as Record<string, any>)?.["acme-chat"];
  const token = section?.token;
  if (!token) throw new Error("acme-chat: token is required");
  return {
    accountId: accountId ?? null,
    token,
    allowFrom: section?.allowFrom ?? [],
    dmPolicy: section?.dmSecurity,
  };
}

export const acmeChatPlugin = createChatChannelPlugin<ResolvedAccount>({
  base: createChannelPluginBase({
    id: "acme-chat",
    setup: {
      resolveAccount,
      inspectAccount(cfg, accountId) {
        const section =
          (cfg.channels as Record<string, any>)?.["acme-chat"];
        return {
          enabled: Boolean(section?.token),
          configured: Boolean(section?.token),
          tokenStatus: section?.token ? "available" : "missing",
        };
      },
    },
  }),

  // DM security: who can message the bot
  security: {
    dm: {
      channelKey: "acme-chat",
      resolvePolicy: (account) => account.dmPolicy,
      resolveAllowFrom: (account) => account.allowFrom,
      defaultPolicy: "allowlist",
    },
  },

  // Pairing: approval flow for new DM contacts
  pairing: {
    text: {
      idLabel: "Acme Chat username",
      message: "Send this code to verify your identity:",
      notify: async ({ target, code }) => {
        await acmeChatApi.sendDm(target, `Pairing code: ${code}`);
      },
    },
  },

  // Threading: how replies are delivered
  threading: { topLevelReplyToMode: "reply" },

  // Outbound: send messages to the platform
  outbound: {
    attachedResults: {
      sendText: async (params) => {
        const result = await acmeChatApi.sendMessage(
          params.to,
          params.text,
        );
        return { messageId: result.id };
      },
    },
    base: {
      sendMedia: async (params) => {
        await acmeChatApi.sendFile(params.to, params.filePath);
      },
    },
  },
});

import { defineChannelPluginEntry } from "openclaw/plugin-sdk/channel-core";
import { acmeChatPlugin } from "./src/channel.js";

export default defineChannelPluginEntry({
  id: "acme-chat",
  name: "Acme Chat",
  description: "Acme Chat channel plugin",
  plugin: acmeChatPlugin,
  registerCliMetadata(api) {
    api.registerCli(
      ({ program }) => {
        program
          .command("acme-chat")
          .description("Acme Chat management");
      },
      {
        descriptors: [
          {
            name: "acme-chat",
            description: "Acme Chat management",
            hasSubcommands: false,
          },
        ],
      },
    );
  },
  registerFull(api) {
    api.registerGatewayMethod(/* ... */);
  },
});

import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core";
import { acmeChatPlugin } from "./src/channel.js";

export default defineSetupPluginEntry(acmeChatPlugin);

registerFull(api) {
  api.registerHttpRoute({
    path: "/acme-chat/webhook",
    auth: "plugin", // plugin-managed auth (verify signatures yourself)
    handler: async (req, res) => {
      const event = parseWebhookPayload(req);

      // Your inbound handler dispatches the message to OpenClaw.
      // The exact wiring depends on your platform SDK —
      // see a real example in the bundled Microsoft Teams or Google Chat plugin package.
      await handleAcmeChatInbound(api, event);

      res.statusCode = 200;
      res.end("ok");
      return true;
    },
  });
}

import { describe, it, expect } from "vitest";
import { acmeChatPlugin } from "./channel.js";

describe("acme-chat plugin", () => {
  it("resolves account from config", () => {
    const cfg = {
      channels: {
        "acme-chat": { token: "test-token", allowFrom: ["user1"] },
      },
    } as any;
    const account = acmeChatPlugin.setup!.resolveAccount(cfg, undefined);
    expect(account.token).toBe("test-token");
  });

  it("inspects account without materializing secrets", () => {
    const cfg = {
      channels: { "acme-chat": { token: "test-token" } },
    } as any;
    const result = acmeChatPlugin.setup!.inspectAccount!(cfg, undefined);
    expect(result.configured).toBe(true);
    expect(result.tokenStatus).toBe("available");
  });

  it("reports missing config", () => {
    const cfg = { channels: {} } as any;
    const result = acmeChatPlugin.setup!.inspectAccount!(cfg, undefined);
    expect(result.configured).toBe(false);
  });
});

pnpm test -- <bundled-plugin-root>/acme-chat/

​

Структура файлів

<bundled-plugin-root>/acme-chat/
├── package.json              # metadata openclaw.channel
├── openclaw.plugin.json      # Маніфест зі схемою конфігурації
├── index.ts                  # defineChannelPluginEntry
├── setup-entry.ts            # defineSetupPluginEntry
├── api.ts                    # Публічні експорти (необов’язково)
├── runtime-api.ts            # Внутрішні runtime-експорти (необов’язково)
└── src/
    ├── channel.ts            # ChannelPlugin через createChatChannelPlugin
    ├── channel.test.ts       # Тести
    ├── client.ts             # API-клієнт платформи
    └── runtime.ts            # Runtime-сховище (за потреби)

​

Розширені теми

​

Наступні кроки

• Provider Plugins — якщо ваш плагін також надає моделі
• SDK Overview — повний довідник з імпортів підшляхів
• SDK Testing — тестові утиліти та контрактні тести
• Plugin Manifest — повна схема маніфесту