Deploying an Extension Application

Applications created with the Client Extension API run in iframes inside the Symphony client.

Symphony apps consist of:

  • The main application controller, a hidden iframe that uses the Client Extension API services to bootstrap your app, extending the Symphony user interface.
  • In most cases, one or more application views, separate iframes that are rendered within Symphony modules.


Apps developed using the Symphony Client Extensions API are not required to use this technology and can be built and deployed using the web development technologies of your choice.

The next sections show the deployment of a Custom App and a Partner Built-In App.

App Deployment

Enterprise Custom App Deployment##

If you are a developer building an application for your own organization (and not to be offered broadly to all Symphony clients in the Symphony Market), then your app must be deployed by your Symphony administrator. The Super Admin should click the "Add Custom App" button on the App Management tab of the Admin Portal.

Your admin should fill out the form presented with the values you will putting in your bundle file. Once the app has been created, it will be assigned a unique ID, which you will then use for your app.

Partner Built-In App Deployment##

If you are a partner building an application for distribution to Symphony's customers, Symphony will deploy your app for you as a "Built-In" app. For testing purposes, Symphony will generally deploy the app in advance on the partner's pod and the Symphony corporate pod.

Partners can deploy their app as a custom app within their own pod. However, the app ID that is generated for the custom app will be different from the app ID that is assigned to your app for built-in customer deployment, so your application code will need to handle multiple IDs.

Updated about a year ago

Deploying an Extension Application

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.