LightningOutApp

Represents a Lightning Out 2.0 application. With a Lightning Out 2.0 app, you can embed Lightning web components (LWC) into external applications. This object is available in API version 65.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported SOAP API Calls

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

Field	Details
ApplicationName	Type string Properties Create, Filter, Group, Sort, Update Description The name of the Lightning Out 2.0 app.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The unique API name of the Lightning Out 2.0 app.
IsEnabled	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Lightning Out 2.0 app is enabled (`true`) or disabled (`false`). The default value is `false`. If the app is disabled, then user authentication fails and the embedded components don’t load in the external app.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the `LightningOutApp`.
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description A user-friendly name for the `LightningOutApp`, which is defined when the `LightningOutApp` is created.

Usage

See Extend Salesforce to External Apps with Lightning Out 2.0 in Salesforce Help and Use Components Outside Salesforce with Lightning Out 2.0 in the Lightning Web Components Developer Guide.

Tooling API

LightningOutApp

Supported SOAP API Calls

Supported REST API Methods

Fields

Usage