createPlugin

mutation · in the family Plugin

What it does

Create a new plugin — a third-party extension registered for your group (it runs on the developer’s own systems) at your organization.

Register a Plugin declaration; requires the unrestricted capability.

Who may call it

Capability area: System and integration setup — Registers, connections and the settings your systems run on.

• Owner
• System Administrator
• An API key whose scope allows api:createPlugin

Arguments

Returns

Plugin Plugin! — A Plugin — a third-party extension's DECLARATION record on the canned-pool selection pattern: the group registers the plugin ONCE, each org ENABLES it via an OrgPlugin selection. Extensions run OUT-OF-PROCESS on the developer's own infrastructure — never in-process here. The record declares what the integration IS: the least-privilege descriptor scopes (the ApiKey grammar, allow-only — the CONTRACT the merchant mints a key against; descriptive at v1, the marketplace's automated mint-flow consumes it later), an optional bound ApiKey identity (validated live in-group at write; informational v1), and its event feed — which rides REAL WebhookSubscription rows carrying pluginId (never a mirrored field). uiSlots is deliberately ABSENT until the office slot system exists (the staged-realization boundary, map d.11). ≤64 per group; doom is gate-protected: a non-doomed OrgPlugin selection OR an un-doomed bound WebhookSubscription blocks it. NOT searchable (integration config).

Example request

mutation ExampleCreatePlugin($input: NewPluginInput!) {
  createPlugin(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    developerName
    homepageUrl
    apiKeyId
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createPlugin": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PN-EXMP-0000-000F",
      "type": "Plugin",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "developerName": "Blue jeans",
      "homepageUrl": "https://example.com/hook",
      "apiKeyId": "01900000-0000-7000-8000-d64fbf430000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
• NOT_FOUND/* — That record could not be found. (NOT_FOUND)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.