- Guides
- Organization terminology upgrade
Guides
Organization terminology upgrade
Upgrade SignalSitter and other invited-alpha clients to the organization contract.
Upgrade to the organization contract
FXO-2337 renames the WhooshBang tenant to organization, including the API, SDK, dashboard, CLI, database and structured logs. This is a clean cut during invited alpha. Update the integration when moving to the deployment containing this change; old tenant names have no compatibility aliases or deprecation window. Your personal sign-in account and your provider accounts retain their meaning.
The approved package batch is @whooshbang/contracts@1.0.0-rc.23,
@whooshbang/sdk@1.0.0-rc.32 and @whooshbang/contract-mock@1.0.0-rc.35,
to be published to next. Approval and staging deployment do not establish
that the npm versions are available; install the exact versions after
publication succeeds. Pin these versions in SignalSitter’s dependency lock
instead of using the moving next tag.
SignalSitter upgrade checklist
| Previous integration surface | Organization contract |
|---|---|
/v1/account and its /credentials and /close routes | /v1/organization and the same suffixes |
account_id in response objects, events and logs | organization_id |
AccountProjection, AccountMembershipSummary, AccountRole | OrganizationProjection, OrganizationMembershipSummary, OrganizationRole |
AccountCredential*, AccountClosure*, and related request types | Corresponding OrganizationCredential*, OrganizationClosure*, and organization request types |
getAccount, closeAccount, listAccountCredentials, createAccountCredential, rotateAccountCredential, revokeAccountCredential | getOrganization, closeOrganization, listOrganizationCredentials, createOrganizationCredential, rotateOrganizationCredential, revokeOrganizationCredential |
account:read | organization:read |
wb credential … --account | wb credential … --organization |
npm run alpha:access -- … --account | npm run alpha:access -- … --organization |
Dashboard /account and its subpages | /organization and the same suffixes |
Organization credential marker wb_ac1 and credential ID prefix acred_ | wb_oc1 and ocred_ |
- Update WhooshBang contracts, SDK and contract-mock dependencies together to
the exact package batch above after publication. Regenerate any local types
or validators from contracts
1.0.0-rc.23. A hosted-app deployment does not publish new npm bytes. - Update explicit tenant fields, method calls, route strings, permissions, mocks, saved response fixtures and any log queries. Update dashboard links and CLI automation too.
- Exercise every WhooshBang call used by SignalSitter, even a project-scoped
call whose application code ignores the tenant field. The older SDK validates
complete responses: an unexpected
organization_idor missingaccount_idcan reject an otherwise successful response before SignalSitter reads it. Keeping the old SDK while changing only application property access is not a complete upgrade. - The migration revokes existing tenant credentials. Create fresh organization credentials through the updated dashboard or CLI and install them in SignalSitter’s approved secret store. Old secrets no longer authenticate. Do not edit credential strings or opaque IDs to turn one prefix into another. Project and machine credentials retain their credential kinds.
- Sign in again and reauthorize existing OAuth clients after the cut. OAuth
project scopes retain their spelling;
organization:readbelongs to organization credentials. Re-run SignalSitter’s test-environment notification and recipient-management journeys and check its response validation and diagnostic logging.
The database migration preserves tenant data and relationships while renaming
the schema. Integrators consume the organization contract; they do not need an
account_id translation layer. Existing tenant IDs stay unchanged; newly created
organizations use the organization_ prefix. Treat every returned identifier as opaque.