Welcome to Zuora Product Documentation

Explore our rich library of product information

Install the Zuora Experiences Canvas component package

Install the Zuora Experiences Canvas component package in your Salesforce org after publishing and hosting your experience. Then configure access through the appropriate installation URLs or Salesforce CLI.

  • Before configuring the Salesforce integration, ensure that the experience is published and hosted. You can host the experience by using one of the following options:

    • Embed it in an existing React application.

    • Embed it in an HTML or JavaScript application.

    • Integrate directly by using the REST API.

    • Host it with Zuora by using Domains and Hosting.

  • Publish the experience to its hosting domain before installing and configuring the Salesforce component. If you are hosting the experience with Zuora, enable hosting for the domain, link it to the project, and publish the project before proceeding. The Salesforce component uses the Canvas App URL https://<your-experience-domain>/auth/canvas/interstitial, so the experience must already be live.

  • Verify that you have Salesforce administrator access to the org in which you want to install the package.

  • Verify that you can access Zuora Experiences Domain Manager so that you can register the Salesforce org.

  1. Install the package in a Production or Developer Edition org by using the following URL:
  2. For a sandbox org, use the following URL:
  3. Optional: Install the package by using the Salesforce CLI:

    sf package install --package 04tdL000000ejxhQAA --target-org <your-org> --wait 20

  4. When prompted during installation, select Install for Admins Only.
    Note:

    The Salesforce package installs only the Zuora Experiences Lightning component. You must create and configure the Salesforce External Client App separately.