Skip to navigation

Add the Zuora Experience component to a Lightning page

View as Markdown

Add the Zuora Experiences component to a Lightning page, configure its properties, and verify that the experience loads correctly in the iframe.

1

Open the target Lightning page and click Edit Page.

2

Drag the Zuora Experiences component onto the page.

3

Configure the component properties.

4

Click Save, and then click Activate.

5

Open the page as a permitted user and verify that the experience loads successfully in the iframe. If a page path is configured, verify that the specified page is displayed.

Otherwise, the experience opens the project’s default landing page.

PropertyRequiredDescription
Tenant SlugYesSpecify the tenant slug for the Zuora Experiences tenant. You can find the tenant slug in the Zuora Experiences user pages or in Domain Manager.
Page PathNoEnter the landing page path after authentication, for example /billing/overview. If you leave this field blank, the experience opens the default landing page configured for the project.
External Client App API NameNoLeave the default value Zuora_Experiences if you used that API name when you created the app. Otherwise, enter the API name of your External Client App.
Canvas App NamespaceNoLeave blank unless your Salesforce org uses a namespace.

When the page loads, Salesforce sends a signed request to the configured Canvas App URL. After the request is validated, the experience is rendered in the iframe.