3U

Plugin SDK

Build remote integrations with createPlugin.

Creating a Plugin

createPlugin defines a remote integration with manifest, permissions, settings, and actions.

Plugin Definition
TypeScript
import { createPlugin } from "threeu-sdk/plugin";

export default createPlugin({
  name: "FastShip",
  slug: "fastship",
  version: "1.0.0",
  category: "shipping",
  ownership: "community",
  permissions: [
    "orders:read", "shipping:write", "customers:read"
  ],
  settings: {
    apiKey: { type: "secret", label: "FastShip API Key", required: true },
    defaultService: {
      type: "select", label: "Default Service",
      options: ["standard", "express"]
    }
  },
  provider: {
    type: "remote_http",
    baseUrl: "https://api.fastship.com/threeu",
    actions: {
      "shipping.get_rates": {
        method: "POST", path: "/actions/get-rates"
      },
      "shipping.create_shipment": {
        method: "POST", path: "/actions/create-shipment"
      }
    },
    webhooks: {
      events: ["shipment.created", "shipment.updated", "shipment.delivered"]
    }
  }
});

Plugin Categories

CategoryDescription
paymentPayment processing and gateways
shippingShipping rates, labels, tracking
sales_channelMarketplace and channel integrations
marketingCampaigns, email, SMS, loyalty
analyticsData collection and reporting
accountingInvoicing, bookkeeping, tax
inventoryStock management and sync
customer_serviceChat, support, helpdesk
aiAI-powered automation
customGeneral-purpose integrations

Plugin Classification

Plugins are classified along four dimensions:

category — Functional domain (shipping, analytics, etc.)

surface_typeplugin (background) or page (UI-embedded)

trigger_modemanual (user-initiated) or automatic (event-driven)

ownershipofficial (ThreeU-built), community (third-party), or custom (brand-specific)