Integrations
Integrations are the system-to-system layer in NewsTeam. They are separate from Apps, which are designed for public read access through the V1 API.
Use integrations when a workflow needs to import content, export content, authenticate readers through an external identity provider, or connect subscription and entitlement data to a billing platform.
The integration model
Section titled “The integration model”Each integration has:
- a type ID, such as
wordpress,ftp,workos, orpaystack - a plugin URL, where NewsTeam can call the integration server
- attributes, used for provider configuration such as URLs, API keys, usernames, or remote paths
- an enabled state for the integration itself
- one or more capability configs: inbound, outbound, identity, and billing
NewsTeam calls the integration server to discover which capabilities a type supports. The plugin server reports the services it implements, and NewsTeam enables the matching capability config in Desk.
That means prebuilt integrations and custom integrations use the same contract. A customer-specific importer, for example, does not need a private path inside the product; it can implement the same inbound service used by the current WordPress, Ghost, Medium, ARC XP, and CosMoS importers.
Capabilities
Section titled “Capabilities”Inbound
Section titled “Inbound”Inbound integrations bring content into NewsTeam.
An inbound integration fetches raw source data from another system, stores it as logfiles, and then processes those logfiles into NewsTeam articles. The inbound config controls where content lands and how it enters the editorial workflow:
- target bucket
- workflow status
- content policy
- auto-publish behavior
- whether imported items should be added to the featured list
- import limit
- cursor state for incremental sync
Current built-in inbound implementations include:
- WordPress
- Ghost
- Medium export files
- ARC XP
- CosMoS
Outbound
Section titled “Outbound”Outbound integrations send NewsTeam content to another system.
The outbound config can watch article lifecycle events and optionally scope pushes to selected feeds. The current event set covers article created, updated, and published events.
When a matching event occurs, NewsTeam loads the article and calls the integration’s outbound Push method. The current built-in implementation is an FTP/SFTP exporter that writes a JSON article manifest and referenced images to a remote directory.
Identity
Section titled “Identity”Identity integrations connect reader authentication to an external identity provider.
The identity service exchanges a provider token for a NewsTeam reader identity payload, including email, verification state, display name, profile image, and optional impersonation information. It can also sign a reader out by revoking the provider session.
The current built-in implementation is WorkOS.
Billing
Section titled “Billing”Billing integrations connect reader subscriptions, checkout, account portals, products, entitlements, and callbacks to an external billing provider.
The billing service can:
- create checkout URLs
- return billing portal URLs
- process provider callbacks
- list products
- list subscriptions
- list entitlement keys
Current built-in implementations include Paystack and Polar.
How it runs
Section titled “How it runs”- Create an integration in Desk with a type, name, plugin URL, and provider attributes.
- Refresh capabilities so NewsTeam can call the plugin server and detect supported services.
- Configure the enabled capability tabs: inbound, outbound, identity, and billing.
- NewsTeam workers call the integration server when work is needed.
- Integration activity is written back to the integration log so operators can see import, export, and provider errors.
Built-in and custom integrations
Section titled “Built-in and custom integrations”The built-in integrations are not special cases. They are implementations of the same IO SDK contracts available to custom integrations.
That gives teams two paths:
- enable a built-in integration when it already matches the workflow
- build a custom plugin server when the source system, destination system, or provider contract is specific to the organization