You are here:
OmniOut
Run Omniscripts and Flexcards off the Salesforce Platform on third-party websites with OmniOut. OmniOut is supported with the standard runtime and Omnistudio standard designer.
Note Content Management System (CMS) configuration is separate from OmniOut. Complete your
CMS configuration before using OmniOut.
Before You Begin
- Install a managed package in your Salesforce Org. See Omnistudio for Managed Packages.
- We recommend using the Omnistudio standard designer. See Omnistudio Standard Designer.
- Make sure you have a CMS built.
- Install Node and npm.
Use Node version 18 to 22. See Installing Node.
- Download Visual Studio Code. See Visual Studio Code.
With OmniOut, you can run an Omniscript or Flexcard on your external site by adding the component to the OmniOut project. You can then integrate OmniOut into your app, and deploy your app to your CMS.
To use OmniOut, perform these tasks.
- Download the OmniOut static resource from Salesforce and open it in Visual Studio Code. See Download the OmniOut Static Resource.
- Install dependencies for the OmniOut project. See Install OmniOut Dependencies.
- Download and add your component to the OmniOut project. To add an Omniscript, see Add an Omniscript Lightning Web Component to OmniOut. To add a Flexcard, see Add a Flexcard LWC to OmniOut.
- To enable a Salesforce API connection, create a Connected App. See Create a Connected App for OmniOut.
- To view and test your component, run OmniOut in development mode. See Run OmniOut in Development Mode.
- Deploy your OmniOut application. See Move OmniOut to Your App.
- Build a connection in your application. See Connect Your OmniOut App.
Did this article solve your issue?
Let us know so we can improve!
