Step 1 — Read the documentation & submit intake form
Read the technical docs including the framework , UI configuration and SSO/authentication articles. Register your interest via the partnership intake form.
Step 2 — Create a manifest
2a. Define OAuth2 clients — Decide which clients (backend/frontend) are needed, including their scopes and API resource permissions.
2b. Define settings — Determine whether tenant admins need to configure the feature (e.g. API keys, checkboxes, dropdowns).
2c. Assess onboarding complexity — If any of the following apply, use the async approach for install, uninstall, and cleanup; otherwise use sync:
External API calls needed
Separate database/schema per tenant
Any operation taking >10 seconds
2d. Write the YAML manifest — Include: id, manifestVersion, name, description, icon, buildInfo (version, vendor details, managementUri, settingsUri), oauth2 client definitions, and settings.
2e. Implement the management endpoint — A publicly accessible HTTPS endpoint handling all lifecycle events:
Event |
| Expected response |
Install |
|
|
Activate |
|
|
Deactivate |
|
|
Update |
|
|
Uninstall |
|
|
Upgrade |
|
|
Cleanup |
|
|
⚠️ Always validate the access token: verify iss, azp, signature, and expiry.
2f. Implement the settings endpoint — Required even with no settings declared (return { "settings": {} }). Must respond within 500ms, as it is called on every user login when the feature is active.
Step 3 — Manifest review by Carerix
Submit the YAML manifest to Carerix for review and approval.
Step 4 — Manifest upload by Carerix
Upon approval, Carerix adds the manifest to the registry, making the feature installable in the Marketplace.
Step 5 — Enable on specific tenant(s) by Carerix
Carerix controls access via whitelist/blacklist. Specify which tenant(s) should have access for testing purposes.
Step 6 — Testing
Test the full lifecycle on the designated tenant(s): install → activate → update settings → deactivate → uninstall. Also verify upgrade and cleanup scenarios.
Step 7 — Pilots
Roll out to a select group of customers via Carerix's whitelist mechanism. After successful pilots, the feature can be made broadly available.