Skip to docs content
JavaScript plugin hello-world
Open Source
Free Cloud
Pro
SDK current
Updated 2026-09-03

JavaScript plugin hello-world

Editions: Open Source · Free Cloud · Pro

Copy from sdk/js-plugin-build-sdk/examples/simple-plugin/main.js.

  1. npm install in the example, then build the plugin package the CLI/engine expects.
  2. config.yml must declare capabilities (project.graphql, project.rest, and/or system caps). Protobuf PLUGIN_TYPE_INTERNAL / PLUGIN_TYPE_EXTERNAL values are reserved — do not reuse numbers.
  3. Install on the engine (apito plugin deploy or copy into PluginPath).
  4. Activate in one project from Project Settings → Plugins.
  5. Call GraphQL/REST. Confirm a second project does not get the plugin.
  6. Deactivate, then remove the package from the host catalog.

Console UI for third-party JS plugins is declarative (host forms). Only Apito-signed official bundles inject compiled Console JavaScript.