Creating a plugin
Use @newsteam/plugin-sdk for a service that NewsTeam calls to import content, push articles, authenticate readers or connect billing. A Site app ID is for the public V1 client; an integration is registered by its reachable service URL and stable type ID.
Start with the current example
Section titled “Start with the current example”The importer walkthrough includes a complete downloadable TypeScript project pinned to @newsteam/plugin-sdk@1.0.0-alpha.3. It has configuration fields, typed discovery, type routing, cursor capture and replay tests. Install Node.js 22.15 or newer, then follow the download and npm ci commands on that page.
For a broader reference, request the developer pack. Its demo-integrations project includes inbound and outbound examples plus clearly labelled action previews:
cd demo-integrationsnpm cinpm run checknpm testnpm run devKeep the lockfile supplied with either project and use the installed package declarations when implementing or upgrading your integration.
Connect a service
Section titled “Connect a service”Develop locally first. The example binds to loopback and imports fictional data. Before using a real integration, deploy it behind an authenticated, access-controlled service endpoint reachable by NewsTeam, configure provider credentials in the integration attributes, and select the discovered type in your organisation’s integration settings. NewsTeam cannot reach a developer’s localhost.
Confirm discovery, recognised capabilities, a fixture import and provider-specific failure handling in the target environment before enabling scheduled or automatic processing. See provider setup for the registered integration catalogue and activation checks.