Publishing a Connector
Versioning the package and the manifest, the SDK constraint, translations, the review and how Subscriby installs a connector, the lanes it moves through, updating it after first publish, and pausing or retiring it.
A connector is installed by Subscriby, not uploaded. Publishing therefore means getting a package to the state Subscriby can review and install, then keeping it there release after release.
Before the first release
connector.json's version is the package's semantic version; start at 1.0.0 when the ports it declares work on the platform, 0.x while they do not. Bump it with every release."sdk": "^1.0" in the manifest and "subscriby/connector-sdk": "^1.0" in composer.json say the same thing; the registry refuses the package at boot if the application's SDK does not satisfy the manifest's constraint. Read the changelog before raising the minor you depend on.lang/<locale>.json. Ship all ten locales Subscriby ships: english, spanish, french, german, italian, portuguese, turkish, hindi, bengali, sinhalese. The application's parity tests fail a key present in one file and missing in another.listing has every field, Listing and Review what to put in them.changelog_url, and a CHANGELOG.md in the package, so Subscriby knows what a version changed before installing it.Submitting
Marketplace submission and per-connector pricing are not open yet. To get a package reviewed today, use Request a connector on the marketplace or write to [email protected] with the repository URL, the tag to review and the kit's report. Subscriby reads the package against the checklist, runs the kit in its own suite, and installs a reviewed connector itself.
What happens after install
Whether creators can install a connector is Subscriby's decision, never the package's claim, and a connector moves through the marketplace's lanes as Subscriby switches it:
| Lane | What it means | What creators see |
|---|---|---|
| Under Development | Subscriby has installed the package but not switched it on yet. | A card in the "building now" lane, no install button. |
| Experimental | Switched on and marked beta. | Installable, marked experimental. |
| Available Now | Switched on. | Installable everywhere. |
| Paused | Switched off by Subscriby during an incident on its side or the platform's. | The card says paused; nothing is sent through the connector, and what members send waits on the platform until it is switched back on. |
The Official badge is Subscriby's configuration for its own connectors; every reviewed third-party package is Community. New appears for sixty days from added_at; Trending marks the most installed connector over thirty days.
Updating a connector
- Additive migrations only once a version is installed anywhere: a data move is expand → verify → contract, with your own verification before any drop. The kit's
migrations.own_tables_onlystill runs on every version. - Bump
versioninconnector.jsonand the manifest'sadded_atstays as it was: it is the first publication date, not the release date. - A new capability is a manifest change and a port binding in the same release; the registry refuses one without the other. Declare it only when it works on the platform.
- A removed capability revokes nothing by itself: installations keep running, and the core stops calling the port. Say so in the changelog, because creators who used it will notice.
- A raised SDK constraint waits for Subscriby to run that SDK; ask before raising it past what production runs.
- Renaming the key is not an update: the key names tables, config, views and routes for the life of the connector. A new key is a new connector.
Pausing and retiring
Subscriby can pause a connector during an incident; ask for it when your platform is misbehaving in a way that would fail every send, and the core queues rather than fails. Retiring a connector is an uninstall on every project, which revokes its grants, detaches its resources and keeps identities and your tables, after which Subscriby switches the connector off; nothing is deleted, and the data rules say what a purge does later.
Check the roadmap first
The marketplace's "building now" and "on the roadmap" lanes name the platforms Subscriby is building connectors for itself. Write to support before starting a package for one of them, so the work is not done twice; a platform on no lane is open.
How is this guide?
Listing and Review
The listing block the marketplace renders, the marketing words the public site borrows, the badges Subscriby stamps, and the checklist a package passes before it is installed.
connector.json
The one file that says what a connector is, what it can do, how it talks and how the marketplace presents it — where it lives, how it is read, and a complete example.