Skip to main content

Forge CLI alignment, extension guides & OpenAPI 1.7.0

Candescent Team
Candescent Team
Developer Experience Team

This release refreshes the Forge CLI documentation for the release CLI: simplified auth, forge doctor, widget/aspect API contract commands, updated template counts and preset names, and removal of deprecated OIDC CLI workflows. We added the Create Your Own section, which covers FI-hosted applications launched in-frame or in a separate browser window, with Candescent managing the widget container, header, and SSO handoff. Additionally, the Extension Points section now describes how the platform defines stable extension point IDs, how extensions register through manifests, and how the extensibility framework resolves and loads them at runtime across web and mobile. This release also updated MX category taxonomy by refining categories and subcategories for consistency and clearer classification.

You can view the OpenAPI specification in the public GitHub repository candescent-dev/openapi.

What's New​

Forge CLI Guides​

  • CLI overview, Installation, Quick start, Widget development, Aspect development, Command reference, and Troubleshooting guides have been revised for the release CLI.
  • Authentication — forge login now documents Sandbox and Production only. Production Stage apps and Prod apps tier selection, --tier, and tier-migration troubleshooting were removed.
  • API access — Registry updated to 99 operations across 9 tag groups. forge api call --use-env documents SDK credential fallback via forge env load / forge env set.
  • Widgets — Catalog updated to seven templates (four web + three mobile). New commands: forge widget set-urls, forge widget api-contract. New flags: --local, --dir, playground --slot, --mobile-device, --pull, --retry-pr.
  • Aspects — Catalog updated to 14 templates. New forge aspect api-contract for preset/backend contracts. The oidc-snippet template and related --client-id / --fi-domain flags are removed.
  • Submissions — Clarified that PRs are created by forge widget submit and forge aspect submit, not a separate repo pr create command.

Extension Points​

  • Extension Points — Created new documents detailing the point-based extensibility framework used across Candescent Digital Banking.
  • Overview — Core pattern: named extension points, manifest-based registration, Extension Registry lookup, and dynamic loading via Module Federation (web) or bundled extensions (mobile).
  • Architecture — Extension microservices, BFF aggregation, Extension Loader bootstrap, in-memory Extension Registry, and the useExtensionPoint hook used by micro apps.
  • Contextual data contract — Runtime context passed to extensions for conditional rendering and FI-specific logic, with security-reviewed data exposure.
  • Available extension points — Catalog of supported integration areas, including Account History quick links, transaction and account detail slide-overs, Group Two attributes, promotional slots, and delinquency indicators (due pills) on My Accounts and Account History — with web and mobile extension point IDs.
  • Mobile considerations — Current limitation: mobile extensions require exact extensionId mapping in @nxg-mobile/extensions; prefix/suffix variants are not supported without a code change.

Create Your Own (CYO)​

  • Create Your Own — Updated documentation on how financial institutions and vendors host custom web applications and surface them inside Candescent Digital Banking.
  • Overview — CYO model: FI or vendor hosts the application endpoint; Candescent surfaces it via SAML SSO inside online or mobile banking. Net-new integrations require coordination with Fintech Integrations before testing.
  • Integration surfaces — CYO widget stack cards, standalone page widgets, and mobile CYO sessions — including where each surface is configured in Experience Groups.
  • Legacy migration — Existing legacy custom widgets convert to Modern CYO stack-card widgets (title → Widget Name, custom.configuration → Widget URL); converted widgets are deactivated by default until an FI Admin activates them.

Building Extensions — Aspects​

  • Aspect template families — Preset ids renamed to vendor-neutral names (e.g. engagement-script-loader, script-config-retail, embedded-service-chat, mobile-chat-jsbridge). Mock partner paths updated (/script-config/handoff/:variant).
  • Aspects overview — Local OIDC testing via Forge CLI was removed.

OIDC Integration​

  • Local Development with the OIDC Toolkit — Removed the Quick Start with Forge CLI section (forge oidc up, oidc-snippet preview). Manual toolkit setup remains the primary path.

MX — Users, Data, and Widgets​

  • Users, Data, and Widgets reference pages are verified against openapi/candescent-di-api.yaml and updated so developers have accurate integration material.
  • List MX Users — GET /mx/users — Description corrected.
  • Get MX User by ID — GET /mx/{institution_id}/users/{user_id} — Parameters, responses, and examples verified against the contract.
  • Download Transaction Logs — GET /mx/download/{institution_id}/{date}/transactions/created — Data export path documented with accurate request and response details.
  • Get MX Widget URL — GET /mx/{institution_id}/users/{user_id}/urls/mini_budgets_widget — Widget URL retrieval documented for the mini budgets widget integration.
  • Postman collections — External MX Postman collections added to support hands-on testing of the updated endpoints.

Get Started​

  1. CLI overview — Capabilities across learn, build, integrate, operate, scale.
  2. Create Your Own — CYO model, SAML SSO, and iframe widgets in Experience Groups.
  3. Extension Points — Point-based extensibility and how it differs from Widgets and Aspects.
  4. Aspect template families — Map templates and presets to your integration.
  5. Candescent DI API — Review updated documentation (OpenAPI 1.7.0).
  6. MX Platform — MX integration overview and passthrough behavior.

The Candescent Developer Experience Team